blob: 618d10e5bd9034a725f19827be7c03779e3e16ec [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
Jaeden Amero15263302017-09-21 12:53:48 +0100386//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300387//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300389//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_RIPEMD160_ALT
391//#define MBEDTLS_SHA1_ALT
392//#define MBEDTLS_SHA256_ALT
393//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000394
Paul Bakker90995b52013-06-24 19:20:35 +0200395/**
TRodziewicz75628d52021-06-18 12:56:27 +0200396 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200397 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200398 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100399 * alternate core implementation of symmetric crypto or hash function. Keep in
400 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200401 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200402 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200404 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200405 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406 * no longer provide the mbedtls_sha1_process() function, but it will still provide
407 * the other function (using your mbedtls_sha1_process() function) and the definition
408 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200409 * with this definition.
410 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200411 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100412 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
413 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200414 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 * Uncomment a macro to enable alternate implementation of the corresponding
416 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100417 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200418 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100419 * constitutes a security risk. If possible, we recommend avoiding
420 * dependencies on them, and considering stronger message digests
421 * and ciphers instead.
422 *
Janos Follath1231d212019-01-07 15:01:32 +0000423 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
424 * enabled, then the deterministic ECDH signature functions pass the
425 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
426 * alternative implementations should use the RNG only for generating
427 * the ephemeral key and nothing else. If this is not possible, then
428 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200429 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000430 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432//#define MBEDTLS_MD5_PROCESS_ALT
433//#define MBEDTLS_RIPEMD160_PROCESS_ALT
434//#define MBEDTLS_SHA1_PROCESS_ALT
435//#define MBEDTLS_SHA256_PROCESS_ALT
436//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200437//#define MBEDTLS_DES_SETKEY_ALT
438//#define MBEDTLS_DES_CRYPT_ECB_ALT
439//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200440//#define MBEDTLS_AES_SETKEY_ENC_ALT
441//#define MBEDTLS_AES_SETKEY_DEC_ALT
442//#define MBEDTLS_AES_ENCRYPT_ALT
443//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300444//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300445//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300446//#define MBEDTLS_ECDSA_VERIFY_ALT
447//#define MBEDTLS_ECDSA_SIGN_ALT
448//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200449
450/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200451 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200452 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200453 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200454 * hardware entropy collector.
455 *
456 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000457 * prototype as declared in library/entropy_poll.h, and accept NULL as first
458 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200459 *
460 * Uncomment to use your own hardware entropy collector.
461 */
462//#define MBEDTLS_ENTROPY_HARDWARE_ALT
463
464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000466 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100467 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000468 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100469 * Uncomment this macro to use precomputed AES tables stored in ROM.
470 * Comment this macro to generate AES tables in RAM at runtime.
471 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100472 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
473 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100474 * initialization time before the first AES operation can be performed.
475 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
476 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
477 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100478 *
479 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200481//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000482
483/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100484 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200485 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100486 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200487 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100488 * Uncommenting this macro omits 75% of the AES tables from
489 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
490 * by computing their values on the fly during operations
491 * (the tables are entry-wise rotations of one another).
492 *
493 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100494 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100495 * runtime. Specifically, one has to compare 4 accesses within
496 * different tables to 4 accesses with additional arithmetic
497 * operations within the same table. The performance gain/loss
498 * depends on the system and memory details.
499 *
500 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200501 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100502//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200503
504/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800505 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
506 *
507 * Use only 128-bit keys in AES operations to save ROM.
508 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800509 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800510 * or 256-bit keys.
511 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800512 * Uncommenting this macro reduces the size of AES code by ~300 bytes
513 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800514 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800515 * Module: library/aes.c
516 *
517 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800518 */
519//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
520
Gilles Peskinea8861e02023-09-05 20:20:51 +0200521/*
522 * Disable plain C implementation for AES.
523 *
524 * When the plain C implementation is enabled, and an implementation using a
525 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
526 * detection will be used to select between them.
527 *
528 * If only one implementation is present, runtime detection will not be used.
529 * This configuration will crash at runtime if running on a CPU without the
530 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
531 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
532 */
533//#define MBEDTLS_AES_USE_HARDWARE_ONLY
534
Arto Kinnunen732ca322023-04-14 14:26:10 +0800535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200537 *
538 * Use less ROM for the Camellia implementation (saves about 768 bytes).
539 *
540 * Uncomment this macro to use less memory for Camellia.
541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200543
544/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200545 * \def MBEDTLS_CHECK_RETURN_WARNING
546 *
547 * If this macro is defined, emit a compile-time warning if application code
548 * calls a function without checking its return value, but the return value
549 * should generally be checked in portable applications.
550 *
551 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
552 * implemented. Otherwise this option has no effect.
553 *
554 * Uncomment to get warnings on using fallible functions without checking
555 * their return value.
556 *
557 * \note This feature is a work in progress.
558 * Warnings will be added to more functions in the future.
559 *
560 * \note A few functions are considered critical, and ignoring the return
561 * value of these functions will trigger a warning even if this
562 * macro is not defined. To completely disable return value check
563 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
564 */
565//#define MBEDTLS_CHECK_RETURN_WARNING
566
567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200569 *
570 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200573
574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000576 *
577 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000580
581/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000583 *
584 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000587
588/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100589 * \def MBEDTLS_CIPHER_MODE_OFB
590 *
591 * Enable Output Feedback mode (OFB) for symmetric ciphers.
592 */
593#define MBEDTLS_CIPHER_MODE_OFB
594
595/**
596 * \def MBEDTLS_CIPHER_MODE_XTS
597 *
598 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
599 */
600#define MBEDTLS_CIPHER_MODE_XTS
601
602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000604 *
605 * Enable NULL cipher.
606 * Warning: Only do so when you know what you are doing. This allows for
607 * encryption or channels without any security!
608 *
Ronald Croncee42702021-04-26 11:34:44 +0200609 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
611 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
612 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
613 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
614 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
615 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
616 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
617 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
618 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
619 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
620 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
621 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
622 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
623 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
624 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
625 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
626 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
627 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
628 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000629 *
630 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000633
634/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100635 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200636 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100637 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
638 * specific padding modes in the cipher layer with cipher modes that support
639 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200640 *
641 * If you disable all padding modes, only full blocks can be used with CBC.
642 *
643 * Enable padding modes in the cipher layer.
644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645#define MBEDTLS_CIPHER_PADDING_PKCS7
646#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
647#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
648#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200649
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200650/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
651 *
652 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800653 * Without this, CTR_DRBG uses a 256-bit key
654 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200655 */
656//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
657
Paul Bakker48e93c82013-08-14 12:21:18 +0200658/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200659 * Enable the verified implementations of ECDH primitives from Project Everest
660 * (currently only Curve25519). This feature changes the layout of ECDH
661 * contexts and therefore is a compatibility break for applications that access
662 * fields of a mbedtls_ecdh_context structure directly. See also
663 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000664 *
665 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
666 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200667 */
668//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
669
670/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100671 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200672 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100673 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
674 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200675 *
676 * Comment macros to disable the curve and functions for it
677 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200678/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
680#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
681#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
682#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
683#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
684#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
685#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
686#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
687#define MBEDTLS_ECP_DP_BP256R1_ENABLED
688#define MBEDTLS_ECP_DP_BP384R1_ENABLED
689#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200690/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200691#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000692#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200693
694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200696 *
697 * Enable specific 'modulo p' routines for each NIST prime.
698 * Depending on the prime and architecture, makes operations 4 to 8 times
699 * faster on the corresponding curve.
700 *
701 * Comment this macro to disable NIST curves optimisation.
702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200704
705/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200706 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100707 *
708 * Enable "non-blocking" ECC operations that can return early and be resumed.
709 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200710 * This allows various functions to pause by returning
711 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
712 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
713 * order to further progress and eventually complete their operation. This is
714 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
715 * number of ECC operations a function may perform before pausing; see
716 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100717 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200718 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200719 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100720 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100721 * This option:
722 * - Adds xxx_restartable() variants of existing operations in the
723 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100724 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
725 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100726 * - ECDSA: signature generation & verification;
727 * - PK: signature generation & verification;
728 * - X509: certificate chain verification.
729 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
730 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
731 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
732 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000733 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100734 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100735 * - verification of the server's key exchange signature;
736 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100737 * - generation of the client's signature if client authentication is used,
738 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100739 *
740 * \note In the cases above, the usual SSL/TLS functions, such as
741 * mbedtls_ssl_handshake(), can now return
742 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200743 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100744 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
745 * restartable operations in PK, X.509 and TLS (see above) are not
746 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100747 * PSA, and are not restartable. These are temporary limitations that
748 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200749 *
Ron Eldor19779c42018-11-05 16:58:13 +0200750 * \note This option only works with the default software implementation of
751 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100752 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100753 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100754 * Requires: MBEDTLS_ECP_C
755 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100756 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100757 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200758//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100759
760/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200761 * Uncomment to enable using new bignum code in the ECC modules.
762 *
763 * \warning This is currently experimental, incomplete and therefore should not
764 * be used in production.
765 */
766//#define MBEDTLS_ECP_WITH_MPI_UINT
767
768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100770 *
771 * Enable deterministic ECDSA (RFC 6979).
772 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
773 * may result in a compromise of the long-term signing key. This is avoided by
774 * the deterministic variant.
775 *
John Durkop36a82e52020-10-26 09:39:05 -0700776 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100777 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100778 * Comment this macro to disable deterministic ECDSA.
779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100781
782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200785 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200786 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200787 * This enables the following ciphersuites (if other requisites are
788 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
790 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
791 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
792 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
793 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
794 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
795 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
796 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
797 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
798 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200801
802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200805 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
809 * This enables the following ciphersuites (if other requisites are
810 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
812 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
813 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
814 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
815 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
816 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
817 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
818 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
819 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
820 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100821 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100822 * \warning Using DHE constitutes a security risk as it
823 * is not possible to validate custom DH parameters.
824 * If possible, it is recommended users should consider
825 * preferring other methods of key exchange.
826 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100827 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200830
831/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200833 *
834 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
835 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200836 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
841 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
842 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
843 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
844 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
845 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200846 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200848
849/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200852 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200853 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
855 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
857 * This enables the following ciphersuites (if other requisites are
858 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
860 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
861 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
862 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
863 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
864 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
865 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
866 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
867 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
868 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871
872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200874 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200875 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200876 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
878 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879 *
880 * This enables the following ciphersuites (if other requisites are
881 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
883 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
884 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
885 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
886 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
887 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
888 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
889 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
890 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
891 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
892 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
893 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896
897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200900 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
903 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 *
905 * This enables the following ciphersuites (if other requisites are
906 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
908 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
909 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
910 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
911 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
912 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
913 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
914 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
915 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
916 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
917 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
918 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100919 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100920 * \warning Using DHE constitutes a security risk as it
921 * is not possible to validate custom DH parameters.
922 * If possible, it is recommended users should consider
923 * preferring other methods of key exchange.
924 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100925 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200928
929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200931 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200932 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200933 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200934 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
935 * MBEDTLS_RSA_C
936 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200938 *
939 * This enables the following ciphersuites (if other requisites are
940 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
942 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
943 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
944 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
945 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
946 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
947 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
948 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
949 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
950 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200951 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953
954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200955 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200956 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200957 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200958 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200959 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
960 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
961 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200962 *
963 * This enables the following ciphersuites (if other requisites are
964 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
967 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
968 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
970 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
971 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
972 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
973 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
974 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200975 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200977
978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100980 *
981 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
982 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200983 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
984 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
985 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100986 *
987 * This enables the following ciphersuites (if other requisites are
988 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
992 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
993 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
996 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
997 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
998 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001001
1002/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001004 *
1005 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1006 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001007 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1008 * MBEDTLS_RSA_C
1009 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001010 *
1011 * This enables the following ciphersuites (if other requisites are
1012 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1014 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1016 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1017 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1018 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1019 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1020 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1021 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1022 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001025
1026/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001027 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1028 *
1029 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1030 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001031 * \warning This is currently experimental. EC J-PAKE support is based on the
1032 * Thread v1.0.0 specification; incompatible changes to the specification
1033 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001034 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001035 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001036 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001037 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1038 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001039 * \warning If SHA-256 is provided only by a PSA driver, you must call
1040 * psa_crypto_init() before the first hanshake (even if
1041 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1042 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001043 * This enables the following ciphersuites (if other requisites are
1044 * enabled as well):
1045 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1046 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001047//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001048
1049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001051 *
1052 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1053 * RFC 5915 and RFC 5480.
1054 *
1055 * Currently this means parsing the SpecifiedECDomain choice of EC
1056 * parameters (only known groups are supported, not arbitrary domains, to
1057 * avoid validation issues).
1058 *
1059 * Disable if you only need to support RFC 5915 + 5480 key formats.
1060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001062
1063/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001064 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1065 *
1066 * Enable the support for parsing public keys of type Short Weierstrass
1067 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001068 * compressed point format. This parsing is done through ECP module's functions.
1069 *
1070 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1071 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1072 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001073 */
1074#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1075
1076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001078 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * Enable a dummy error function to make use of mbedtls_strerror() in
1080 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1081 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001082 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1084 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001085 *
1086 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001090
1091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001093 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001094 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001095 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001097 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001099
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001102 *
1103 * Enable functions that use the filesystem.
1104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001109 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001110 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001111 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001112 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001113 * application.
1114 *
1115 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001118
1119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001121 *
1122 * Do not use built-in platform entropy functions.
1123 * This is useful if your platform does not support
1124 * standards like the /dev/urandom or Windows CryptoAPI.
1125 *
1126 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001129
1130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001132 *
1133 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1134 * default SHA-512 based one (if both are available).
1135 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001137 *
1138 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1139 * if you have performance concerns.
1140 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 * This option is only useful if both MBEDTLS_SHA256_C and
1142 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001145
1146/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001147 * \def MBEDTLS_ENTROPY_NV_SEED
1148 *
1149 * Enable the non-volatile (NV) seed file-based entropy source.
1150 * (Also enables the NV seed read/write functions in the platform layer)
1151 *
1152 * This is crucial (if not required) on systems that do not have a
1153 * cryptographic entropy source (in hardware or kernel) available.
1154 *
1155 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1156 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001157 * \note The read/write functions that are used by the entropy source are
1158 * determined in the platform layer, and can be modified at runtime and/or
1159 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1160 *
1161 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001162 * with regular fopen(), please make sure you make a seedfile with the
1163 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1164 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001165 * and written to or you will get an entropy source error! The default
1166 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1167 * bytes from the file.
1168 *
1169 * \note The entropy collector will write to the seed file before entropy is
1170 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001171 */
1172//#define MBEDTLS_ENTROPY_NV_SEED
1173
Ronald Cron71016a92020-08-28 19:01:50 +02001174/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001175 *
Ronald Cron71016a92020-08-28 19:01:50 +02001176 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001177 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001178 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1179 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001180 *
1181 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001182 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001183 */
Ronald Cron71016a92020-08-28 19:01:50 +02001184//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001185
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001188 *
1189 * Enable debugging of buffer allocator memory issues. Automatically prints
1190 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1191 * function for 'debug output' of allocated memory.
1192 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001194 *
1195 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001198
1199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001200 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001201 *
1202 * Include backtrace information with each allocated block.
1203 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001205 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001206 *
1207 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001210
1211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001213 *
1214 * Support external private RSA keys (eg from a HSM) in the PK layer.
1215 *
1216 * Comment this macro to disable support for external private RSA keys.
1217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001219
1220/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001222 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001223 * Enable support for PKCS#1 v1.5 encoding.
1224 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001225 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001226 *
Paul Bakker48377d92013-08-30 12:06:24 +02001227 * This enables support for PKCS#1 v1.5 operations.
1228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001230
1231/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001232 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001233 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001234 * Enable support for PKCS#1 v2.1 encoding.
1235 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001236 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001237 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001238 * \warning If using a hash that is only provided by PSA drivers, you must
1239 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001240 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001241 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001244
Steven Cooreman6801f082021-02-19 17:21:22 +01001245/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1246 *
1247 * Enable support for platform built-in keys. If you enable this feature,
1248 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1249 * See the documentation of that function for more information.
1250 *
1251 * Built-in keys are typically derived from a hardware unique key or
1252 * stored in a secure element.
1253 *
1254 * Requires: MBEDTLS_PSA_CRYPTO_C.
1255 *
1256 * \warning This interface is experimental and may change or be removed
1257 * without notice.
1258 */
1259//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1260
Ronald Cron3768ac12021-01-26 16:58:00 +01001261/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1262 *
1263 * Enable support for PSA crypto client.
1264 *
1265 * \note This option allows to include the code necessary for a PSA
1266 * crypto client when the PSA crypto implementation is not included in
1267 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1268 * code to set and get PSA key attributes.
1269 * The development of PSA drivers partially relying on the library to
1270 * fulfill the hardware gaps is another possible usage of this option.
1271 *
1272 * \warning This interface is experimental and may change or be removed
1273 * without notice.
1274 */
1275//#define MBEDTLS_PSA_CRYPTO_CLIENT
1276
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001277/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1278 *
1279 * Make the PSA Crypto module use an external random generator provided
1280 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1281 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001282 * \note This random generator must deliver random numbers with cryptographic
1283 * quality and high performance. It must supply unpredictable numbers
1284 * with a uniform distribution. The implementation of this function
1285 * is responsible for ensuring that the random generator is seeded
1286 * with sufficient entropy. If you have a hardware TRNG which is slow
1287 * or delivers non-uniform output, declare it as an entropy source
1288 * with mbedtls_entropy_add_source() instead of enabling this option.
1289 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001290 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001291 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1292 * and define a function called mbedtls_psa_external_get_random()
1293 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001294 * ```
1295 * psa_status_t mbedtls_psa_external_get_random(
1296 * mbedtls_psa_external_random_context_t *context,
1297 * uint8_t *output, size_t output_size, size_t *output_length);
1298 * );
1299 * ```
1300 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001301 * The function must fill the \c output buffer with \c output_size bytes
1302 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001303 *
1304 * Requires: MBEDTLS_PSA_CRYPTO_C
1305 *
1306 * \warning If you enable this option, code that uses the PSA cryptography
1307 * interface will not use any of the entropy sources set up for
1308 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1309 * enables.
1310 *
1311 * \note This option is experimental and may be removed without notice.
1312 */
1313//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1314
Paul Bakker9dcc3222011-03-08 14:16:06 +00001315/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001316 * \def MBEDTLS_PSA_CRYPTO_SPM
1317 *
1318 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1319 * Partition Manager) integration which separates the code into two parts: a
1320 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1321 * Environment).
1322 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001323 * If you enable this option, your build environment must include a header
1324 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1325 * header files, or in another directory on the compiler's include search
1326 * path). Alternatively, your platform may customize the header
1327 * `psa/crypto_platform.h`, in which case it can skip or replace the
1328 * inclusion of `"crypto_spe.h"`.
1329 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001330 * Module: library/psa_crypto.c
1331 * Requires: MBEDTLS_PSA_CRYPTO_C
1332 *
1333 */
1334//#define MBEDTLS_PSA_CRYPTO_SPM
1335
1336/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001337 * Uncomment to enable p256-m. This is an alternative implementation of
1338 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1339 * Compared to the default implementation:
1340 *
1341 * - p256-m has a much smaller code size and RAM footprint.
1342 * - p256-m is only available via the PSA API. This includes the pk module
1343 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1344 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1345 * over the core arithmetic, or deterministic derivation of keys.
1346 *
1347 * We recommend enabling this option if your application uses the PSA API
1348 * and the only elliptic curve support it needs is ECDH and ECDSA over
1349 * SECP256R1.
1350 *
1351 * If you enable this option, you do not need to enable any ECC-related
1352 * MBEDTLS_xxx option. You do need to separately request support for the
1353 * cryptographic mechanisms through the PSA API:
1354 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1355 * configuration;
1356 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1357 * - #PSA_WANT_ECC_SECP_R1_256;
1358 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1359 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1360 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1361 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1362 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001363 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001364 * \note To benefit from the smaller code size of p256-m, make sure that you
1365 * do not enable any ECC-related option not supported by p256-m: this
1366 * would cause the built-in ECC implementation to be built as well, in
1367 * order to provide the required option.
1368 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001369 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1370 * SECP256R1 are disabled as they are not supported by this driver.
1371 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1372 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001373 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001374 */
1375//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1376
1377/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001378 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001379 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001380 * Enable support for entropy injection at first boot. This feature is
1381 * required on systems that do not have a built-in entropy source (TRNG).
1382 * This feature is currently not supported on systems that have a built-in
1383 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001384 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001385 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001386 *
1387 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001388//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001389
1390/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001391 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001392 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001393 * Assume all buffers passed to PSA functions are owned exclusively by the
1394 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001395 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001396 * This option may be enabled if all buffers passed to any PSA function reside
1397 * in memory that is accessible only to the PSA function during its execution.
1398 *
1399 * This option MUST be disabled whenever buffer arguments are in memory shared
1400 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001401 * across a trust boundary.
1402 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001403 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001404 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001405 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001406 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001407 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001408//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001409
1410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001412 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001413 * Do not use the Chinese Remainder Theorem
1414 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001415 *
1416 * Uncomment this macro to disable the use of CRT in RSA.
1417 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001420
1421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001422 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001423 *
1424 * Enable the checkup functions (*_self_test).
1425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001427
1428/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001429 * \def MBEDTLS_SHA256_SMALLER
1430 *
1431 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1432 * lower performance.
1433 *
Adam Wolf039080f2019-09-10 09:53:08 -05001434 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001435 * performance and size. This version optimizes more aggressively for size at
1436 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1437 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1438 * 30%.
1439 *
1440 * Uncomment to enable the smaller implementation of SHA256.
1441 */
1442//#define MBEDTLS_SHA256_SMALLER
1443
1444/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001445 * \def MBEDTLS_SHA512_SMALLER
1446 *
1447 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1448 * lower performance.
1449 *
1450 * Uncomment to enable the smaller implementation of SHA512.
1451 */
1452//#define MBEDTLS_SHA512_SMALLER
1453
1454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001456 *
1457 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001458 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001459 * with other servers, only debugging of failures is harder.
1460 *
1461 * The advantage of not sending alert messages, is that no information is given
1462 * about reasons for failures thus preventing adversaries of gaining intel.
1463 *
1464 * Enable sending of all alert messages
1465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001467
1468/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001469 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1470 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001471 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001472 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001473 * in the underlying transport. The CID functionality is described
1474 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001475 *
1476 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001477 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1478 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1479 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001480 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001481 * The maximum lengths of outgoing and incoming CIDs can be configured
1482 * through the options
1483 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1484 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1485 *
1486 * Requires: MBEDTLS_SSL_PROTO_DTLS
1487 *
1488 * Uncomment to enable the Connection ID extension.
1489 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001490#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1491
1492
1493/**
1494 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1495 *
1496 * Defines whether RFC 9146 (default) or the legacy version
1497 * (version draft-ietf-tls-dtls-connection-id-05,
1498 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1499 * is used.
1500 *
1501 * Set the value to 0 for the standard version, and
1502 * 1 for the legacy draft version.
1503 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001504 * \deprecated Support for the legacy version of the DTLS
1505 * Connection ID feature is deprecated. Please
1506 * switch to the standardized version defined
1507 * in RFC 9146 enabled by utilizing
1508 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1509 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1510 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001511 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1512 */
1513#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001514
1515/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001516 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1517 *
1518 * Enable asynchronous external private key operations in SSL. This allows
1519 * you to configure an SSL connection to call an external cryptographic
1520 * module to perform private key operations instead of performing the
1521 * operation inside the library.
1522 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001523 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001524 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001525//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001526
1527/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001528 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1529 *
1530 * Enable serialization of the TLS context structures, through use of the
1531 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1532 *
1533 * This pair of functions allows one side of a connection to serialize the
1534 * context associated with the connection, then free or re-use that context
1535 * while the serialized state is persisted elsewhere, and finally deserialize
1536 * that state to a live context for resuming read/write operations on the
1537 * connection. From a protocol perspective, the state of the connection is
1538 * unaffected, in particular this is entirely transparent to the peer.
1539 *
1540 * Note: this is distinct from TLS session resumption, which is part of the
1541 * protocol and fully visible by the peer. TLS session resumption enables
1542 * establishing new connections associated to a saved session with shorter,
1543 * lighter handshakes, while context serialization is a local optimization in
1544 * handling a single, potentially long-lived connection.
1545 *
1546 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1547 * saved after the handshake to allow for more efficient serialization, so if
1548 * you don't need this feature you'll save RAM by disabling it.
1549 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001550 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1551 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001552 * Comment to disable the context serialization APIs.
1553 */
1554#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1555
1556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001558 *
1559 * Enable the debug messages in SSL module for all issues.
1560 * Debug messages have been disabled in some places to prevent timing
1561 * attacks due to (unbalanced) debugging function calls.
1562 *
1563 * If you need all error reporting you should enable this during debugging,
1564 * but remove this for production servers that should log as well.
1565 *
1566 * Uncomment this macro to report all debug messages on errors introducing
1567 * a timing side-channel.
1568 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001570//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001573 *
1574 * Enable support for Encrypt-then-MAC, RFC 7366.
1575 *
1576 * This allows peers that both support it to use a more robust protection for
1577 * ciphersuites using CBC, providing deep resistance against timing attacks
1578 * on the padding or underlying cipher.
1579 *
1580 * This only affects CBC ciphersuites, and is useless if none is defined.
1581 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001582 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001583 *
1584 * Comment this macro to disable support for Encrypt-then-MAC
1585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001586#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001587
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001589 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001590 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1591 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001592 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001593 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001594 * attacks, but it is recommended to always use it (even if you disable
1595 * renegotiation), since it actually fixes a more fundamental issue in the
1596 * original SSL/TLS design, and has implications beyond Triple Handshake.
1597 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001598 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001599 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001600 * Comment this macro to disable support for Extended Master Secret.
1601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001602#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001603
Paul Bakkerd66f0702013-01-31 16:57:45 +01001604/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001605 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1606 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001607 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001608 * giving access to the peer's certificate after completion of the handshake.
1609 *
1610 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1611 * recommended to disable this option for reduced RAM usage.
1612 *
1613 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1614 * defined, but always returns \c NULL.
1615 *
1616 * \note This option has no influence on the protection against the
1617 * triple handshake attack. Even if it is disabled, Mbed TLS will
1618 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001619 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001620 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001621 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001622 *
1623 * Comment this macro to disable storing the peer's certificate
1624 * after the handshake.
1625 */
1626#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1627
1628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001630 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001631 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001632 *
1633 * The two main uses of renegotiation are (1) refresh keys on long-lived
1634 * connections and (2) client authentication after the initial handshake.
1635 * If you don't need renegotiation, it's probably better to disable it, since
1636 * it has been associated with security issues in the past and is easy to
1637 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001638 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001639 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1640 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001641 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001642 *
1643 * \note Even if this option is disabled, both client and server are aware
1644 * of the Renegotiation Indication Extension (RFC 5746) used to
1645 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1646 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1647 * configuration of this extension).
1648 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001651
1652/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001653 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001654 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001655 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001656 *
1657 * Comment this macro to disable support for the max_fragment_length extension
1658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001660
1661/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001662 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1663 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001664 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001665 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001666 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1667 *
1668 * Uncomment this macro to enable support for the record_size_limit extension
1669 */
1670//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1671
1672/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001673 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001674 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001675 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001676 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001677 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001678 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1679 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001680 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001681 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001682 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001683 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1684 * are only provided by PSA drivers, you must call psa_crypto_init() before
1685 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001686 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001687 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001688 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001690
1691/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001692 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001693 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001694 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001695 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001696 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001697 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001698 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001699 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001700 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001701 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001702 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1703 * directly performed by TLS 1.3 code. As a consequence, you must
1704 * call psa_crypto_init() before the first TLS 1.3 handshake.
1705 *
1706 * \note Cryptographic operations performed indirectly via another module
1707 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1708 * running handshake hash) only use PSA crypto if
1709 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001710 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001711 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001712 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001713#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001714
1715/**
Ronald Cronab65c522021-11-24 10:47:20 +01001716 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1717 *
1718 * Enable TLS 1.3 middlebox compatibility mode.
1719 *
1720 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1721 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1722 * expecting TLS 1.2 traffic.
1723 *
1724 * Turning on the compatibility mode comes at the cost of a few added bytes
1725 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1726 * that don't use it. Therefore, unless transmission bandwidth is critical and
1727 * you know that middlebox compatibility issues won't occur, it is therefore
1728 * recommended to set this option.
1729 *
1730 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001731 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1732 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001733 *
1734 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001735#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001736
1737/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001738 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1739 *
1740 * Enable TLS 1.3 PSK key exchange mode.
1741 *
1742 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1743 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1744 * effect on the build.
1745 *
1746 */
1747#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1748
1749/**
1750 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1751 *
1752 * Enable TLS 1.3 ephemeral key exchange mode.
1753 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001754 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001755 * MBEDTLS_X509_CRT_PARSE_C
1756 * and at least one of:
1757 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1758 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001759 *
1760 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1761 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1762 * effect on the build.
1763 *
1764 */
1765#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1766
1767/**
1768 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1769 *
1770 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1771 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001772 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001773 *
1774 * Comment to disable support for the PSK ephemeral key exchange mode in
1775 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1776 * have any effect on the build.
1777 *
1778 */
1779#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1780
1781/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001782 * \def MBEDTLS_SSL_EARLY_DATA
1783 *
1784 * Enable support for RFC 8446 TLS 1.3 early data.
1785 *
1786 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1787 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1788 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1789 *
1790 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1791 * is not enabled, this option does not have any effect on the build.
1792 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001793 * \note The maximum amount of early data can be set with
1794 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1795 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001797//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001798
1799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001801 *
1802 * Enable support for DTLS (all available versions).
1803 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001804 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001805 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001806 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001807 *
1808 * Comment this macro to disable support for DTLS
1809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001811
1812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001814 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001815 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001816 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001817 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001820
1821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001823 *
1824 * Enable support for the anti-replay mechanism in DTLS.
1825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * Requires: MBEDTLS_SSL_TLS_C
1827 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001828 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001829 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001830 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001831 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001832 * Comment this to disable anti-replay in DTLS.
1833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001835
1836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001838 *
1839 * Enable support for HelloVerifyRequest on DTLS servers.
1840 *
1841 * This feature is highly recommended to prevent DTLS servers being used as
1842 * amplifiers in DoS attacks against other hosts. It should always be enabled
1843 * unless you know for sure amplification cannot be a problem in the
1844 * environment in which your server operates.
1845 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001846 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001847 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001848 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001849 *
1850 * Comment this to disable support for HelloVerifyRequest.
1851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001852#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001853
1854/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001855 * \def MBEDTLS_SSL_DTLS_SRTP
1856 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001857 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001858 * through the use_srtp extension.
1859 *
1860 * \note This feature provides the minimum functionality required
1861 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1862 * the associated SRTP packet protection key material.
1863 * In particular, the SRTP packet protection itself, as well as the
1864 * demultiplexing of RTP and DTLS packets at the datagram layer
1865 * (see Section 5 of RFC 5764), are not handled by this feature.
1866 * Instead, after successful completion of a handshake negotiating
1867 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001868 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001869 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1870 * (this is implemented in the SSL example programs).
1871 * The resulting key should then be passed to an SRTP stack.
1872 *
1873 * Setting this option enables the runtime API
1874 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1875 * through which the supported DTLS-SRTP protection
1876 * profiles can be configured. You must call this API at
1877 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001878 *
1879 * Requires: MBEDTLS_SSL_PROTO_DTLS
1880 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001881 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001882 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001883//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001884
1885/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001886 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1887 *
1888 * Enable server-side support for clients that reconnect from the same port.
1889 *
1890 * Some clients unexpectedly close the connection and try to reconnect using the
1891 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001892 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001893 * flag enables that support.
1894 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001895 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001896 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001897 * Comment this to disable support for clients reusing the source port.
1898 */
1899#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001903 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001904 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001905 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001906 * session store remains the responsibility of the application, though).
1907 * Server-side, you also need to provide callbacks for writing and parsing
1908 * tickets, including authenticated encryption and key management. Example
1909 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001910 *
1911 * Comment this macro to disable support for SSL session tickets
1912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001914
1915/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001917 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001918 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001919 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001921 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001922 * Comment this macro to disable support for server name indication in SSL
1923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001924#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001925
1926/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001927 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1928 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001929 * When this option is enabled, the SSL buffer will be resized automatically
1930 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001931 *
1932 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001933 */
1934//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1935
1936/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001937 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1938 *
1939 * Enable testing of the constant-flow nature of some sensitive functions with
1940 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001941 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001942 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001943 * This setting requires compiling with clang -fsanitize=memory. The test
1944 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001945 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001946 * \warning This macro is only used for extended testing; it is not considered
1947 * part of the library's API, so it may change or disappear at any time.
1948 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001949 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001950 */
1951//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1952
1953/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001954 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1955 *
1956 * Enable testing of the constant-flow nature of some sensitive functions with
1957 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001958 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001959 *
1960 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001961 * testing if the tests suites are run with valgrind's memcheck. This can be
1962 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1963 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001964 *
1965 * \warning This macro is only used for extended testing; it is not considered
1966 * part of the library's API, so it may change or disappear at any time.
1967 *
1968 * Uncomment to enable testing of the constant-flow nature of selected code.
1969 */
1970//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1971
1972/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001973 * \def MBEDTLS_TEST_HOOKS
1974 *
1975 * Enable features for invasive testing such as introspection functions and
1976 * hooks for fault injection. This enables additional unit tests.
1977 *
1978 * Merely enabling this feature should not change the behavior of the product.
1979 * It only adds new code, and new branching points where the default behavior
1980 * is the same as when this feature is disabled.
1981 * However, this feature increases the attack surface: there is an added
1982 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1983 * Therefore this feature must never be enabled in production.
1984 *
1985 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1986 * information.
1987 *
1988 * Uncomment to enable invasive tests.
1989 */
1990//#define MBEDTLS_TEST_HOOKS
1991
1992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001994 *
1995 * Provide your own alternate threading implementation.
1996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001998 *
1999 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002002
2003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002005 *
2006 * Enable the pthread wrapper layer for the threading layer.
2007 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002009 *
2010 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002011 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002013
2014/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002015 * \def MBEDTLS_USE_PSA_CRYPTO
2016 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002017 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2018 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002019 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002020 * \note Development of this option is currently in progress, and parts of Mbed
2021 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002022 * will still continue to work as usual, so enabling this option should not
2023 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002024 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002025 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002026 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2027 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002028 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002029 * \note An important and desirable effect of this option is that it allows
2030 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2031 * 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 +02002032 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002033 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2034 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002035 *
2036 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002037 *
2038 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002039 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002040 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002042//#define MBEDTLS_USE_PSA_CRYPTO
2043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002044/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002045 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2046 *
John Durkop185764f2020-10-12 21:32:12 -07002047 * This setting allows support for cryptographic mechanisms through the PSA
2048 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002049 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002050 * When this option is disabled, the PSA API exposes the cryptographic
2051 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2052 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002053 *
2054 * When this option is enabled, the PSA API exposes the cryptographic
2055 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2056 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2057 * automatically enabled if required (i.e. if no PSA driver provides the
2058 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2059 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002060 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002061 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002062 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002063 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002064 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2065 * symbols is not completely finalized yet, and the configuration
2066 * tooling is not ideally adapted to having two separate configuration
2067 * files.
2068 * Future minor releases of Mbed TLS may make minor changes to those
2069 * symbols, but we will endeavor to provide a transition path.
2070 * Nonetheless, this option is considered mature enough to use in
2071 * production, as long as you accept that you may need to make
2072 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002073 */
2074//#define MBEDTLS_PSA_CRYPTO_CONFIG
2075
2076/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002077 * \def MBEDTLS_VERSION_FEATURES
2078 *
2079 * Allow run-time checking of compile-time enabled features. Thus allowing users
2080 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002081 * support via mbedtls_version_check_feature().
2082 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002083 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002084 *
2085 * Comment this to disable run-time checking and save ROM space
2086 */
2087#define MBEDTLS_VERSION_FEATURES
2088
2089/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002090 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2091 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002092 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002093 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2094 * the set of trusted certificates through a callback instead of a linked
2095 * list.
2096 *
2097 * This is useful for example in environments where a large number of trusted
2098 * certificates is present and storing them in a linked list isn't efficient
2099 * enough, or when the set of trusted certificates changes frequently.
2100 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002101 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002102 * `mbedtls_ssl_conf_ca_cb()` for more information.
2103 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002104 * Requires: MBEDTLS_X509_CRT_PARSE_C
2105 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002106 * Uncomment to enable trusted certificate callbacks.
2107 */
2108//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2109
2110/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002111 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002112 *
Chris Jones2c745862020-12-16 11:41:06 +00002113 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002114 *
Chris Jones2c745862020-12-16 11:41:06 +00002115 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002116 * and other functions/constants only used by these functions, thus reducing
2117 * the code footprint by several KB.
2118 */
Chris Jones2c745862020-12-16 11:41:06 +00002119//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002120
2121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002123 *
2124 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2125 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2126 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002127 * Requires: MBEDTLS_PKCS1_V21
2128 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002129 * Comment this macro to disallow using RSASSA-PSS in certificates.
2130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002132/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002133
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002134/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002135 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002136 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002137 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002138 * \{
2139 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002140
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002143 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002144 * Enable AES-NI support on x86-64 or x86-32.
2145 *
2146 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002147 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002148 * - GCC, x86-64, target not explicitly supporting AESNI:
2149 * requires MBEDTLS_HAVE_ASM.
2150 * - GCC, x86-32, target not explicitly supporting AESNI:
2151 * not supported.
2152 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2153 * For this assembly-less implementation, you must currently compile
2154 * `library/aesni.c` and `library/aes.c` with machine options to enable
2155 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2156 * `clang -maes -mpclmul`.
2157 * - Non-x86 targets: this option is silently ignored.
2158 * - Other compilers: this option is silently ignored.
2159 *
2160 * \note
2161 * Above, "GCC" includes compatible compilers such as Clang.
2162 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002163 *
2164 * Module: library/aesni.c
2165 * Caller: library/aes.c
2166 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002167 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002168 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002169 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002172
2173/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002174 * \def MBEDTLS_AESCE_C
2175 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002176 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002177 *
2178 * Module: library/aesce.c
2179 * Caller: library/aes.c
2180 *
Jerry Yuf015a932023-04-25 10:38:03 +08002181 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002182 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002183 * \warning Runtime detection only works on Linux. For non-Linux operating
2184 * system, Armv8-A Cryptographic Extensions must be supported by
2185 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002186 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002187 * \note Minimum compiler versions for this feature when targeting aarch64
2188 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2189 * Minimum compiler versions for this feature when targeting 32-bit
2190 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002191 *
2192 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2193 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002194 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002195 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002196 */
2197#define MBEDTLS_AESCE_C
2198
2199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002200 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002201 *
2202 * Enable the AES block cipher.
2203 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002204 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002205 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002206 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002207 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002208 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002209 * This module enables the following ciphersuites (if other requisites are
2210 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2212 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2213 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2214 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2215 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2216 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2217 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2218 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2219 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2220 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2221 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2222 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2223 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2224 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2225 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2226 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2227 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2228 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2229 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2230 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2231 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2232 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2233 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2234 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2235 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2237 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2238 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2239 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2240 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2241 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2242 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2243 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2244 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2245 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2246 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2247 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2248 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2249 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2250 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2251 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2252 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2253 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2254 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2255 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2256 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2257 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2258 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2259 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2260 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2261 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2262 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2263 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2264 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2265 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2266 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2267 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2268 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002269 *
Paul Bakkercff68422013-09-15 20:43:33 +02002270 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002273
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002274/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002275 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002276 *
2277 * Enable the generic ASN1 parser.
2278 *
2279 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002280 * Caller: library/x509.c
2281 * library/dhm.c
2282 * library/pkcs12.c
2283 * library/pkcs5.c
2284 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002287
2288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002290 *
2291 * Enable the generic ASN1 writer.
2292 *
2293 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002294 * Caller: library/ecdsa.c
2295 * library/pkwrite.c
2296 * library/x509_create.c
2297 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002298 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002301
2302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002304 *
2305 * Enable the Base64 module.
2306 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002307 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002308 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002309 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002310 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314/**
Yanray Wange367e472023-10-31 17:23:04 +08002315 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2316 *
2317 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2318 *
2319 * \note This feature is incompatible with insecure block cipher,
2320 * MBEDTLS_DES_C, and cipher modes which always require decryption
2321 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002322 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2323 * this feature is incompatible with following supported PSA equivalence,
2324 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2325 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002326 *
2327 * Module: library/aes.c
2328 * library/aesce.c
2329 * library/aesni.c
2330 * library/aria.c
2331 * library/camellia.c
2332 * library/cipher.c
2333 */
2334//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2335
2336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002338 *
Paul Bakker9a736322012-11-14 12:39:52 +00002339 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002340 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002341 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002342 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002343 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002344 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002345 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002346 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002347 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002348 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002349 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002351 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002352 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002355
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002356/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002357 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002358 *
2359 * Enable the Camellia block cipher.
2360 *
Paul Bakker38119b12009-01-10 23:31:23 +00002361 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002362 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002363 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002364 * This module enables the following ciphersuites (if other requisites are
2365 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2367 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2368 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2369 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2370 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2371 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2372 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2373 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2375 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2376 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2377 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2378 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2379 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2380 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2381 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2382 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2383 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2384 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2385 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2386 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2387 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2388 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2389 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2390 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2391 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2392 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2393 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2394 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2395 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2396 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2397 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2398 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2399 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2400 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2401 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2402 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2403 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2404 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2405 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2406 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2407 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002410
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002411/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002412 * \def MBEDTLS_ARIA_C
2413 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002414 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002415 *
2416 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002417 * Caller: library/cipher.c
2418 *
2419 * This module enables the following ciphersuites (if other requisites are
2420 * enabled as well):
2421 *
2422 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2423 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2424 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2425 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2426 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2427 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2428 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2429 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2430 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2431 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2432 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2433 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2434 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2435 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2436 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2437 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2438 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2439 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2440 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2441 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2442 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2443 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2444 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2445 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2446 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2447 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2448 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2449 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2450 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2451 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2452 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2453 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2454 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2455 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2456 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2457 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2458 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2459 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002460 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002461#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002462
2463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002465 *
2466 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2467 *
2468 * Module: library/ccm.c
2469 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002470 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2471 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002472 *
2473 * This module enables the AES-CCM ciphersuites, if other requisites are
2474 * enabled as well.
2475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002476#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002477
2478/**
Daniel King34b822c2016-05-15 17:28:08 -03002479 * \def MBEDTLS_CHACHA20_C
2480 *
2481 * Enable the ChaCha20 stream cipher.
2482 *
2483 * Module: library/chacha20.c
2484 */
2485#define MBEDTLS_CHACHA20_C
2486
2487/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002488 * \def MBEDTLS_CHACHAPOLY_C
2489 *
2490 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2491 *
2492 * Module: library/chachapoly.c
2493 *
2494 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2495 */
2496#define MBEDTLS_CHACHAPOLY_C
2497
2498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002500 *
2501 * Enable the generic cipher layer.
2502 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002503 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002504 * Caller: library/ccm.c
2505 * library/cmac.c
2506 * library/gcm.c
2507 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002508 * library/pkcs12.c
2509 * library/pkcs5.c
2510 * library/psa_crypto_aead.c
2511 * library/psa_crypto_mac.c
2512 * library/ssl_ciphersuites.c
2513 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002514 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002515 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2516 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002517 *
2518 * Uncomment to enable generic cipher wrappers.
2519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002521
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002522/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002523 * \def MBEDTLS_CMAC_C
2524 *
Simon Butcher327398a2016-10-05 14:09:11 +01002525 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2526 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002527 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002528 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2529 * implementation of the CMAC algorithm is provided by an alternate
2530 * implementation, that alternate implementation may opt to not support
2531 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2532 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002533 * Module: library/cmac.c
2534 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002535 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002536 *
2537 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002538#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002542 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002543 * Enable the CTR_DRBG AES-based random generator.
2544 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002545 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002546 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002547 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2548 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2549 * is used.
2550 *
2551 * \warning When using PSA, the user should call `psa_crypto_init()` before
2552 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2553 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002554 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2555 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002556 * \note To achieve a 256-bit security strength with CTR_DRBG,
2557 * you must use AES-256 *and* use sufficient entropy.
2558 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002559 *
2560 * Module: library/ctr_drbg.c
2561 * Caller:
2562 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002563 * Requires: MBEDTLS_AES_C or
2564 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2565 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002566 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002567 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002570
2571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002573 *
2574 * Enable the debug functions.
2575 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002576 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002577 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002578 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002579 * library/ssl_tls12_*.c
2580 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002581 *
2582 * This module provides debugging functions.
2583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002585
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002588 *
2589 * Enable the DES block cipher.
2590 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002591 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002592 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002593 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002594 *
Paul Bakkercff68422013-09-15 20:43:33 +02002595 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002596 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002597 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002598 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002601
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002604 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002605 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002606 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002607 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002608 * Caller: library/ssl_tls.c
2609 * library/ssl*_client.c
2610 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002611 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002612 * This module is used by the following key exchanges:
2613 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002614 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002615 * \warning Using DHE constitutes a security risk as it
2616 * is not possible to validate custom DH parameters.
2617 * If possible, it is recommended users should consider
2618 * preferring other methods of key exchange.
2619 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002620 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002623
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002624/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002626 *
2627 * Enable the elliptic curve Diffie-Hellman library.
2628 *
2629 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002630 * Caller: library/psa_crypto.c
2631 * library/ssl_tls.c
2632 * library/ssl*_client.c
2633 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002634 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002635 * This module is used by the following key exchanges:
2636 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002637 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002641
2642/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002644 *
2645 * Enable the elliptic curve DSA library.
2646 *
2647 * Module: library/ecdsa.c
2648 * Caller:
2649 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002650 * This module is used by the following key exchanges:
2651 * ECDHE-ECDSA
2652 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002653 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2654 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2655 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002658
2659/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002660 * \def MBEDTLS_ECJPAKE_C
2661 *
2662 * Enable the elliptic curve J-PAKE library.
2663 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002664 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2665 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002666 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002667 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002668 * Module: library/ecjpake.c
2669 * Caller:
2670 *
2671 * This module is used by the following key exchanges:
2672 * ECJPAKE
2673 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002674 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002675 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002676 * \warning If using a hash that is only provided by PSA drivers, you must
2677 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002678 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002679#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002680
2681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002683 *
2684 * Enable the elliptic curve over GF(p) library.
2685 *
2686 * Module: library/ecp.c
2687 * Caller: library/ecdh.c
2688 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002689 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002690 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002694
2695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002697 *
2698 * Enable the platform-specific entropy code.
2699 *
2700 * Module: library/entropy.c
2701 * Caller:
2702 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002703 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002704 *
2705 * This module provides a generic entropy pool
2706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002708
2709/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002711 *
2712 * Enable error code to error string conversion.
2713 *
2714 * Module: library/error.c
2715 * Caller:
2716 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002720
2721/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002723 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002724 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002725 *
2726 * Module: library/gcm.c
2727 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002728 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2729 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002730 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002731 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2732 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002735
2736/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002737 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002738 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002739 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002740 * Can significantly increase throughput on systems without GCM hardware
2741 * acceleration (e.g., AESNI, AESCE).
2742 *
Matthias Schulz78266782024-02-08 13:54:48 +01002743 * The mbedtls_gcm_context size will increase by 3840 bytes.
2744 * The code size will increase by roughly 344 bytes.
2745 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002746 * Module: library/gcm.c
2747 *
2748 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002749 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002750//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002751
2752/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002753 * \def MBEDTLS_HKDF_C
2754 *
2755 * Enable the HKDF algorithm (RFC 5869).
2756 *
2757 * Module: library/hkdf.c
2758 * Caller:
2759 *
2760 * Requires: MBEDTLS_MD_C
2761 *
2762 * This module adds support for the Hashed Message Authentication Code
2763 * (HMAC)-based key derivation function (HKDF).
2764 */
2765#define MBEDTLS_HKDF_C
2766
2767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002769 *
2770 * Enable the HMAC_DRBG random generator.
2771 *
2772 * Module: library/hmac_drbg.c
2773 * Caller:
2774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002776 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002777 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002780
2781/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002782 * \def MBEDTLS_LMS_C
2783 *
2784 * Enable the LMS stateful-hash asymmetric signature algorithm.
2785 *
2786 * Module: library/lms.c
2787 * Caller:
2788 *
Raef Colesab4f8742022-09-01 12:24:31 +01002789 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002790 *
Raef Colesab4f8742022-09-01 12:24:31 +01002791 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002792 */
2793#define MBEDTLS_LMS_C
2794
2795/**
Raef Colesab4f8742022-09-01 12:24:31 +01002796 * \def MBEDTLS_LMS_PRIVATE
2797 *
2798 * Enable LMS private-key operations and signing code. Functions enabled by this
2799 * option are experimental, and should not be used in production.
2800 *
2801 * Requires: MBEDTLS_LMS_C
2802 *
2803 * Uncomment to enable the LMS signature algorithm and private key operations.
2804 */
Raef Coles5127e852022-10-07 10:35:56 +01002805//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002806
2807/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002808 * \def MBEDTLS_NIST_KW_C
2809 *
2810 * Enable the Key Wrapping mode for 128-bit block ciphers,
2811 * as defined in NIST SP 800-38F. Only KW and KWP modes
2812 * are supported. At the moment, only AES is approved by NIST.
2813 *
2814 * Module: library/nist_kw.c
2815 *
2816 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2817 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002818#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002819
2820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002823 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002824 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002825 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2826 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002827 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002828 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002829 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002830 * Caller: library/constant_time.c
2831 * library/ecdsa.c
2832 * library/ecjpake.c
2833 * library/hkdf.c
2834 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002835 * library/pk.c
2836 * library/pkcs5.c
2837 * library/pkcs12.c
2838 * library/psa_crypto_ecp.c
2839 * library/psa_crypto_rsa.c
2840 * library/rsa.c
2841 * library/ssl_cookie.c
2842 * library/ssl_msg.c
2843 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002844 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002845 * library/x509_crt.c
2846 * library/x509write_crt.c
2847 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002848 *
2849 * Uncomment to enable generic message digest wrappers.
2850 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002852
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002853/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002855 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002856 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002857 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002858 * Module: library/md5.c
2859 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002860 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002861 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002862 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002863 * This module is required for TLS 1.2 depending on the handshake parameters.
2864 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2865 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002866 *
2867 * \warning MD5 is considered a weak message digest and its use constitutes a
2868 * security risk. If possible, we recommend avoiding dependencies on
2869 * it, and considering stronger message digests instead.
2870 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002873
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002876 *
2877 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002878 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002879 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002880 *
2881 * Module: library/memory_buffer_alloc.c
2882 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002883 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002884 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002885 *
2886 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002889
2890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002892 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002893 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2894 *
Simon Butcherd567a232016-03-09 20:19:21 +00002895 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2896 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002897 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002898 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002899 * \note See also our Knowledge Base article about porting to a new
2900 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002901 * 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 +00002902 *
Andres AG788aa4a2016-09-14 14:32:09 +01002903 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002904 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002905 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002908
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002911 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002912 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002913 *
2914 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002915 * Caller: library/asn1write.c
2916 * library/pkcs5.c
2917 * library/pkparse.c
2918 * library/pkwrite.c
2919 * library/rsa.c
2920 * library/x509.c
2921 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002922 * library/x509_crl.c
2923 * library/x509_crt.c
2924 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002925 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002926 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002927 *
2928 * This modules translates between OIDs and internal values.
2929 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002931
2932/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002934 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002935 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002936 *
2937 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002938 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002939 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002940 * library/x509_crl.c
2941 * library/x509_crt.c
2942 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002943 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002945 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2946 *
2947 * \warning When parsing password-protected files, if MD5 is provided only by
2948 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002949 *
Paul Bakkercff68422013-09-15 20:43:33 +02002950 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002951 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002953
2954/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002956 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002957 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002958 *
2959 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002960 * Caller: library/pkwrite.c
2961 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002962 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002965 *
2966 * This modules adds support for encoding / writing PEM files.
2967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002969
2970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002972 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002973 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002974 *
2975 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002976 * Caller: library/psa_crypto_rsa.c
2977 * library/ssl_tls.c
2978 * library/ssl*_client.c
2979 * library/ssl*_server.c
2980 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002981 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002982 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002983 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002984 * Uncomment to enable generic public key wrappers.
2985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002987
2988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002990 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002991 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002992 *
2993 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002994 * Caller: library/x509_crt.c
2995 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002996 *
Yanray Wang072a0682023-12-05 10:53:04 +08002997 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002998 *
2999 * Uncomment to enable generic public key parse functions.
3000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003002
3003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003005 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003006 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003007 *
3008 * Module: library/pkwrite.c
3009 * Caller: library/x509write.c
3010 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003011 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003012 *
3013 * Uncomment to enable generic public key write functions.
3014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003016
3017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003019 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003020 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003021 *
3022 * Module: library/pkcs5.c
3023 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003024 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003025 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003026 * \warning If using a hash that is only provided by PSA drivers, you must
3027 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003028 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003029 * This module adds support for the PKCS#5 functions.
3030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003032
3033/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003034 * \def MBEDTLS_PKCS7_C
3035 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003036 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003037 * RFC Link - https://tools.ietf.org/html/rfc2315
3038 *
3039 * Module: library/pkcs7.c
3040 *
3041 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003042 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3043 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003044 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003045 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003046 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003047#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003048
3049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003050 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003051 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003052 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003053 * Adds algorithms for parsing PKCS#8 encrypted private keys
3054 *
3055 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003056 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003057 *
Valerio Settie98ad592023-12-28 10:42:12 +01003058 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3059 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003060 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003061 * \warning If using a hash that is only provided by PSA drivers, you must
3062 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003063 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003064 * This module enables PKCS#12 functions.
3065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003067
3068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003070 *
3071 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003072 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003073 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3075 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003076 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003077 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003078 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003079 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003080 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003081 * Module: library/platform.c
3082 * Caller: Most other .c files
3083 *
3084 * This module enables abstraction of common (libc) functions.
3085 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003086#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003087
3088/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003089 * \def MBEDTLS_POLY1305_C
3090 *
3091 * Enable the Poly1305 MAC algorithm.
3092 *
3093 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003094 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003095 */
3096#define MBEDTLS_POLY1305_C
3097
3098/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003099 * \def MBEDTLS_PSA_CRYPTO_C
3100 *
3101 * Enable the Platform Security Architecture cryptography API.
3102 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003103 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003104 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003105 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003106 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003107 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3108 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3109 * is enabled in PSA (unless it's fully accelerated, see
3110 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003111 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003112#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003113
3114/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003115 * \def MBEDTLS_PSA_CRYPTO_SE_C
3116 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003117 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003118 * cryptography API.
3119 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003120 * \deprecated This feature is deprecated. Please switch to the PSA driver
3121 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003122 *
Ryan Everett32a64582024-03-05 18:16:18 +00003123 * \warning This feature is not thread-safe, and should not be used in a
3124 * multi-threaded environment.
3125 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003126 * Module: library/psa_crypto_se.c
3127 *
3128 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3129 *
3130 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003131//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003132
3133/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003134 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3135 *
3136 * Enable the Platform Security Architecture persistent key storage.
3137 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003138 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003139 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003140 * Requires: MBEDTLS_PSA_CRYPTO_C,
3141 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3142 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003143 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003144#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003145
3146/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003147 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003148 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003149 * Enable the emulation of the Platform Security Architecture
3150 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003151 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003152 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003153 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003154 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003155 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003156#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003157
3158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003159 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003160 *
3161 * Enable the RIPEMD-160 hash algorithm.
3162 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003163 * Module: library/ripemd160.c
3164 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003165 *
3166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003168
3169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003171 *
3172 * Enable the RSA public-key cryptosystem.
3173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003174 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003175 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003176 * Caller: library/pk.c
3177 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003178 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003179 * library/ssl*_client.c
3180 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003181 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003182 * This module is used by the following key exchanges:
3183 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003184 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003188
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003191 *
3192 * Enable the SHA1 cryptographic hash algorithm.
3193 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003194 * Module: library/sha1.c
3195 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003196 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003198 * This module is required for TLS 1.2 depending on the handshake parameters,
3199 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003200 *
3201 * \warning SHA-1 is considered a weak message digest and its use constitutes
3202 * a security risk. If possible, we recommend avoiding dependencies
3203 * on it, and considering stronger message digests instead.
3204 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003207
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003208/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003209 * \def MBEDTLS_SHA224_C
3210 *
3211 * Enable the SHA-224 cryptographic hash algorithm.
3212 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003213 * Module: library/sha256.c
3214 * Caller: library/md.c
3215 * library/ssl_cookie.c
3216 *
3217 * This module adds support for SHA-224.
3218 */
3219#define MBEDTLS_SHA224_C
3220
3221/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003223 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003224 * Enable the SHA-256 cryptographic hash algorithm.
3225 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003226 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003227 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003228 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003229 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003230 * library/ssl*_client.c
3231 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003232 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003233 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003234 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003235 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003237
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003238/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003239 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003240 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003241 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3242 * with the ARMv8 cryptographic extensions if they are available at runtime.
3243 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003244 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003245 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003246 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003247 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003248 * \note Minimum compiler versions for this feature are Clang 4.0,
3249 * armclang 6.6 or GCC 6.0.
3250 *
3251 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3252 * armclang <= 6.9
3253 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003254 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3255 * That name is deprecated, but may still be used as an alternative form for this
3256 * option.
3257 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003258 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3259 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003260 *
3261 * Requires: MBEDTLS_SHA256_C.
3262 *
3263 * Module: library/sha256.c
3264 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003265 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003266 * and use them if available.
3267 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003268//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003269
Dave Rodgmand85277c2023-10-13 09:22:54 +01003270/**
3271 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3272 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003273 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003274 * This name is now deprecated, but may still be used as an alternative form for
3275 * this option.
3276 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003277//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3278
3279/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003280 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003281 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003282 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3283 * with the ARMv8 cryptographic extensions, which must be available at runtime
3284 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003285 *
3286 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003287 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003288 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003289 * \note Minimum compiler versions for this feature are Clang 4.0,
3290 * armclang 6.6 or GCC 6.0.
3291 *
3292 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3293 * armclang <= 6.9
3294 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003295 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003296 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003297 * option.
3298 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003299 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3300 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003301 *
3302 * Requires: MBEDTLS_SHA256_C.
3303 *
3304 * Module: library/sha256.c
3305 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003306 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003307 * unconditionally.
3308 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003309//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003310
Dave Rodgmand85277c2023-10-13 09:22:54 +01003311/**
3312 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3313 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003314 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003315 * This name is now deprecated, but may still be used as an alternative form for
3316 * this option.
3317 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003318//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3319
3320/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003321 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003322 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003323 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003324 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003325 * Module: library/sha512.c
3326 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003327 * library/psa_crypto_hash.c
3328 * library/ssl_tls.c
3329 * library/ssl*_client.c
3330 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003331 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003332 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003333 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003334#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003335
3336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003338 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003339 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003340 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003341 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003342 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003343 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003344 * library/ssl_tls.c
3345 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003347 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003350
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003351/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003352 * \def MBEDTLS_SHA3_C
3353 *
3354 * Enable the SHA3 cryptographic hash algorithm.
3355 *
3356 * Module: library/sha3.c
3357 *
3358 * This module adds support for SHA3.
3359 */
3360#define MBEDTLS_SHA3_C
3361
3362/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003363 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3364 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003365 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3366 * with the ARMv8 cryptographic extensions if they are available at runtime.
3367 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003368 *
3369 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3370 * for a non-Aarch64 build it will be silently ignored.
3371 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003372 * \note Minimum compiler versions for this feature are Clang 7.0,
3373 * armclang 6.9 or GCC 8.0.
3374 *
3375 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3376 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003377 *
3378 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3379 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3380 *
3381 * Requires: MBEDTLS_SHA512_C.
3382 *
3383 * Module: library/sha512.c
3384 *
3385 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3386 * and use them if available.
3387 */
3388//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3389
3390/**
3391 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3392 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003393 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3394 * with the ARMv8 cryptographic extensions, which must be available at runtime
3395 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003396 *
3397 * \note This allows builds with a smaller code size than with
3398 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3399 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003400 * \note Minimum compiler versions for this feature are Clang 7.0,
3401 * armclang 6.9 or GCC 8.0.
3402 *
3403 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3404 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003405 *
3406 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3407 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3408 *
3409 * Requires: MBEDTLS_SHA512_C.
3410 *
3411 * Module: library/sha512.c
3412 *
3413 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3414 * unconditionally.
3415 */
3416//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3417
3418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003420 *
3421 * Enable simple SSL cache implementation.
3422 *
3423 * Module: library/ssl_cache.c
3424 * Caller:
3425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003429
3430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003432 *
3433 * Enable basic implementation of DTLS cookies for hello verification.
3434 *
3435 * Module: library/ssl_cookie.c
3436 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003439
3440/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003441 * \def MBEDTLS_SSL_TICKET_C
3442 *
3443 * Enable an implementation of TLS server-side callbacks for session tickets.
3444 *
3445 * Module: library/ssl_ticket.c
3446 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003447 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003448 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3449 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003450 */
3451#define MBEDTLS_SSL_TICKET_C
3452
3453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003455 *
3456 * Enable the SSL/TLS client code.
3457 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003458 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003459 * Caller:
3460 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003462 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003463 * This module is required for SSL/TLS client support.
3464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003466
Paul Bakker9a736322012-11-14 12:39:52 +00003467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003468 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003469 *
3470 * Enable the SSL/TLS server code.
3471 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003472 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003473 * Caller:
3474 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003476 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003477 * This module is required for SSL/TLS server support.
3478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003480
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003482 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003483 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003484 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003485 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003486 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003487 * Caller: library/ssl*_client.c
3488 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003489 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3491 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003492 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003493 * This module is required for SSL/TLS.
3494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003496
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003499 *
3500 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003501 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003502 * contexts are not shared between threads. If you do intend to use contexts
3503 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003504 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003505 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003506 *
3507 * Module: library/threading.c
3508 *
3509 * This allows different threading implementations (self-implemented or
3510 * provided).
3511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * You will have to enable either MBEDTLS_THREADING_ALT or
3513 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003514 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003515 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003518
3519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003521 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003522 * Enable the semi-portable timing interface.
3523 *
Simon Butcherd567a232016-03-09 20:19:21 +00003524 * \note The provided implementation only works on POSIX/Unix (including Linux,
3525 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003526 * module and provide your own implementations of the callbacks needed by
3527 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3528 * your own implementation of the whole module by setting
3529 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003530 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003531 * \note The timing module will include time.h on suitable platforms
3532 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3533 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3534 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003535 * \note See also our Knowledge Base article about porting to a new
3536 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003537 * 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 +00003538 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003545 *
3546 * Enable run-time version information.
3547 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003548 * Module: library/version.c
3549 *
3550 * This module provides run-time version information.
3551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003553
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003556 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003557 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003558 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003559 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003560 * Caller: library/x509_crl.c
3561 * library/x509_crt.c
3562 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003563 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003564 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003565 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3566 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003567 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3568 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003569 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003570 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003573
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003576 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003577 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003578 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003579 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003580 * Caller: library/ssl_tls.c
3581 * library/ssl*_client.c
3582 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003583 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003585 *
3586 * This module is required for X.509 certificate parsing.
3587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589
3590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003592 *
3593 * Enable X.509 CRL parsing.
3594 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003595 * Module: library/x509_crl.c
3596 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003599 *
3600 * This module is required for X.509 CRL parsing.
3601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603
3604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003606 *
3607 * Enable X.509 Certificate Signing Request (CSR) parsing.
3608 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003609 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 * Caller: library/x509_crt_write.c
3611 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003612 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003613 *
3614 * This module is used for reading X.509 certificate request.
3615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617
3618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003620 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003621 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003622 *
3623 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003624 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003625 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003626 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3627 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003628 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3629 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003630 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003631 * This module is the basis for creating X.509 certificates and CSRs.
3632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003634
3635/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003637 *
3638 * Enable creating X.509 certificates.
3639 *
3640 * Module: library/x509_crt_write.c
3641 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003642 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003643 *
3644 * This module is required for X.509 certificate creation.
3645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003646#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003647
3648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003650 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003651 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003652 *
3653 * Module: library/x509_csr_write.c
3654 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003656 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003657 * This module is required for X.509 certificate request writing.
3658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003660
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003661/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003662
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003663/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003664 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003665 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003666 * This section contains Mbed TLS build settings that are not associated
3667 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003668 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003669 * \{
3670 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003671
Gilles Peskinea02c1242022-03-16 17:03:19 +01003672/**
3673 * \def MBEDTLS_CONFIG_FILE
3674 *
3675 * If defined, this is a header which will be included instead of
3676 * `"mbedtls/mbedtls_config.h"`.
3677 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003678 * Unlike other configuration options, this one must be defined on the
3679 * compiler command line: a definition in `mbedtls_config.h` would have
3680 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003681 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003682 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003683 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003684 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003685 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003686 * The value of this symbol is typically a path in double quotes, either
3687 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003688 */
3689//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3690
3691/**
3692 * \def MBEDTLS_USER_CONFIG_FILE
3693 *
3694 * If defined, this is a header which will be included after
3695 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003696 * This allows you to modify the default configuration, including the ability
3697 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003698 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003699 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003700 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003701 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003702 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003703 * The value of this symbol is typically a path in double quotes, either
3704 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003705 */
3706//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3707
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003708/**
3709 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3710 *
3711 * If defined, this is a header which will be included instead of
3712 * `"psa/crypto_config.h"`.
3713 * This header file specifies which cryptographic mechanisms are available
3714 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3715 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3716 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003717 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003718 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003719 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003720 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003721 * The value of this symbol is typically a path in double quotes, either
3722 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003723 */
3724//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3725
3726/**
3727 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3728 *
3729 * If defined, this is a header which will be included after
3730 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003731 * This allows you to modify the default configuration, including the ability
3732 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003733 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003734 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003735 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003736 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003737 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003738 * The value of this symbol is typically a path in double quotes, either
3739 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003740 */
3741//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3742
Gilles Peskineb1176f22023-02-22 22:07:28 +01003743/**
3744 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3745 *
3746 * If defined, this is a header which will be included instead of
3747 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3748 * as the one in Mbed TLS, but with definitions adapted to the platform on
3749 * which the library code will run.
3750 *
3751 * \note The required content of this header can vary from one version of
3752 * Mbed TLS to the next. Integrators who provide an alternative file
3753 * should review the changes in the original file whenever they
3754 * upgrade Mbed TLS.
3755 *
3756 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3757 * non-standard feature of the C language, so this feature is only available
3758 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3759 *
3760 * The value of this symbol is typically a path in double quotes, either
3761 * absolute or relative to a directory on the include search path.
3762 */
3763//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3764
3765/**
3766 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3767 *
3768 * If defined, this is a header which will be included instead of
3769 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3770 * as the one in Mbed TLS, but with definitions adapted to the environment
3771 * in which the library code will run. The typical use for this feature
3772 * is to provide alternative type definitions on the client side in
3773 * client-server integrations of PSA crypto, where operation structures
3774 * contain handles instead of cryptographic data.
3775 *
3776 * \note The required content of this header can vary from one version of
3777 * Mbed TLS to the next. Integrators who provide an alternative file
3778 * should review the changes in the original file whenever they
3779 * upgrade Mbed TLS.
3780 *
3781 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3782 * non-standard feature of the C language, so this feature is only available
3783 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3784 *
3785 * The value of this symbol is typically a path in double quotes, either
3786 * absolute or relative to a directory on the include search path.
3787 */
3788//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3789
Gilles Peskineba4162a2022-04-11 17:04:38 +02003790/** \} name SECTION: General configuration options */
3791
3792/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003793 * \name SECTION: Module configuration options
3794 *
3795 * This section allows for the setting of module specific sizes and
3796 * configuration options. The default values are already present in the
3797 * relevant header files and should suffice for the regular use cases.
3798 *
3799 * Our advice is to enable options and change their values here
3800 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003801 * \{
3802 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003803/* The Doxygen documentation here is used when a user comments out a
3804 * setting and runs doxygen themselves. On the other hand, when we typeset
3805 * the full documentation including disabled settings, the documentation
3806 * in specific modules' header files is used if present. When editing this
3807 * file, make sure that each option is documented in exactly one place,
3808 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3809 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003810
Paul Bakker088c5c52014-04-25 11:11:10 +02003811/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003812//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003814
Paul Bakker088c5c52014-04-25 11:11:10 +02003815/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003816//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3817//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3818//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3819//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3820//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003821
Paul Bakker088c5c52014-04-25 11:11:10 +02003822/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003823//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3824//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3825//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3826//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003827
Paul Bakker088c5c52014-04-25 11:11:10 +02003828/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003829//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003831
Paul Bakker088c5c52014-04-25 11:11:10 +02003832/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003833//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3834//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003835//#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 +01003836
Paul Bakker088c5c52014-04-25 11:11:10 +02003837/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003839
Paul Bakker088c5c52014-04-25 11:11:10 +02003840/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003841//#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 -04003842
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003843/** \def MBEDTLS_PLATFORM_STD_CALLOC
3844 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003845 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003846 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003847 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003848 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003849 * 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 -04003850 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3851 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003852 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003853 */
3854//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003855
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003856/** \def MBEDTLS_PLATFORM_STD_FREE
3857 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003858 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003859 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003860 * 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 -04003861 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3862 * 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 -04003863 */
3864//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003865//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003866//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003867//#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 +02003868//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3869//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003870/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003871//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003872//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3873//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003874//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3875//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3876//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003877
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003878/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003880//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3881//#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 +02003882//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003883//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003884//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3885//#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 +02003886//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3887//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003888/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003890//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003891//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3892//#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 +08003893//#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 +08003894//#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 +02003895
Gilles Peskine3f106f72021-09-23 17:42:39 +02003896/** \def MBEDTLS_CHECK_RETURN
3897 *
3898 * This macro is used at the beginning of the declaration of a function
3899 * to indicate that its return value should be checked. It should
3900 * instruct the compiler to emit a warning or an error if the function
3901 * is called without checking its return value.
3902 *
3903 * There is a default implementation for popular compilers in platform_util.h.
3904 * You can override the default implementation by defining your own here.
3905 *
3906 * If the implementation here is empty, this will effectively disable the
3907 * checking of functions' return values.
3908 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003909//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003910
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003911/** \def MBEDTLS_IGNORE_RETURN
3912 *
3913 * This macro requires one argument, which should be a C function call.
3914 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3915 * warning is suppressed.
3916 */
3917//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3918
Gilles Peskineed038902020-11-13 21:33:21 +01003919/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003920/**
Gilles Peskineed038902020-11-13 21:33:21 +01003921 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3922 * PSA crypto subsystem.
3923 *
3924 * If this option is unset:
3925 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003926 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003927 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3928 * on unspecified heuristics.
3929 */
3930//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3931
Steven Cooreman863470a2021-02-15 14:03:19 +01003932/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003933 * Restrict the PSA library to supporting a maximum amount of simultaneously
3934 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3935 * volatile key, or a persistent key which is loaded temporarily by the
3936 * library as part of a crypto operation in flight.
3937 *
3938 * If this option is unset, the library will fall back to a default value of
3939 * 32 keys.
3940 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003941//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003942
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003943/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003944//#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 +00003945
Paul Bakker088c5c52014-04-25 11:11:10 +02003946/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3948//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003949
Paul Bakker088c5c52014-04-25 11:11:10 +02003950/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003951
Angus Grattond8213d02016-05-25 20:56:48 +10003952/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3953 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003954 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003955 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003956 * This determines the size of the incoming TLS I/O buffer in such a way
3957 * that it is capable of holding the specified amount of plaintext data,
3958 * regardless of the protection mechanism used.
3959 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003960 * \note When using a value less than the default of 16KB on the client, it is
3961 * recommended to use the Maximum Fragment Length (MFL) extension to
3962 * inform the server about this limitation. On the server, there
3963 * is no supported, standardized way of informing the client about
3964 * restriction on the maximum size of incoming messages, and unless
3965 * the limitation has been communicated by other means, it is recommended
3966 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3967 * while keeping the default value of 16KB for the incoming buffer.
3968 *
David Horstmann95d516f2021-05-04 18:36:56 +01003969 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003970 */
3971//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3972
Gilles Peskined3d02902020-03-04 21:35:27 +01003973/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3974 *
3975 * The maximum length of CIDs used for incoming DTLS messages.
3976 *
3977 */
3978//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3979
3980/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3981 *
3982 * The maximum length of CIDs used for outgoing DTLS messages.
3983 *
3984 */
3985//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3986
TRodziewicze8dd7092021-05-12 14:19:11 +02003987/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003988 *
3989 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003990 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003991 *
3992 * The padding will always be chosen so that the length of the
3993 * padded plaintext is a multiple of the value of this option.
3994 *
3995 * Note: A value of \c 1 means that no padding will be used
3996 * for outgoing records.
3997 *
3998 * Note: On systems lacking division instructions,
3999 * a power of two should be preferred.
4000 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004001//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004002
Angus Grattond8213d02016-05-25 20:56:48 +10004003/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4004 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004005 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004006 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004007 * This determines the size of the outgoing TLS I/O buffer in such a way
4008 * that it is capable of holding the specified amount of plaintext data,
4009 * regardless of the protection mechanism used.
4010 *
Angus Grattond8213d02016-05-25 20:56:48 +10004011 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4012 * the default inward 16384 byte buffer to conform to the TLS specification.
4013 *
4014 * The minimum required outward buffer size is determined by the handshake
4015 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4016 * The specific size requirement depends on the configured ciphers and any
4017 * certificate data which is sent during the handshake.
4018 *
David Horstmann95d516f2021-05-04 18:36:56 +01004019 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004020 */
4021//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4022
Hanno Beckere0b150f2018-08-21 15:51:03 +01004023/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4024 *
4025 * Maximum number of heap-allocated bytes for the purpose of
4026 * DTLS handshake message reassembly and future message buffering.
4027 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004028 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004029 * to account for a reassembled handshake message of maximum size,
4030 * together with its reassembly bitmap.
4031 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004032 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004033 * should be sufficient for all practical situations as it allows
4034 * to reassembly a large handshake message (such as a certificate)
4035 * while buffering multiple smaller handshake messages.
4036 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004037 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004038//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004039
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004040//#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 +02004041//#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 +02004042
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004043/**
4044 * Complete list of ciphersuites to use, in order of preference.
4045 *
4046 * \warning No dependency checking is done on that field! This option can only
4047 * be used to restrict the set of available ciphersuites. It is your
4048 * responsibility to make sure the needed modules are active.
4049 *
4050 * Use this to save a few hundred bytes of ROM (default ordering of all
4051 * available ciphersuites) and a few to a few hundred bytes of RAM.
4052 *
4053 * The value below is only an example, not the default.
4054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004055//#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 +02004056
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004057/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004058 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4059 *
4060 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004061 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004062 *
4063 * It must be positive and smaller than UINT32_MAX.
4064 *
4065 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4066 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004067 */
4068//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4069
4070/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004071 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4072 *
Jerry Yucf913512023-11-14 11:06:52 +08004073 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004074 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004075 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004076 * - The client ticket age is the time difference between the time when the
4077 * client proposes to the server to use the ticket and the time the client
4078 * received the ticket from the server.
4079 * - The server ticket age is the time difference between the time when the
4080 * server receives a proposition from the client to use the ticket and the
4081 * time when the ticket was created by the server.
4082 *
Jerry Yucf913512023-11-14 11:06:52 +08004083 * The ages might be different due to the client and server clocks not running
4084 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4085 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4086 * 6s, thus in the worst case clients and servers must sync up their system time
4087 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004088 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004089 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004090 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004091//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004092
4093/**
4094 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4095 *
4096 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4097 *
4098 * This must be less than 256.
4099 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004100//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004101
4102/**
4103 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4104 *
4105 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4106 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4107 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4108 *
4109 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004110//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004111
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004112/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004113//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004114//#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 +01004115
Gilles Peskine611179c2022-04-13 23:04:48 +02004116/** \} name SECTION: Module configuration options */