blob: c1f08f9d3878961ee7b545ab9ea58af56d4b94f0 [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
Steven Cooreman63342772017-04-04 11:47:16 +0200382//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383//#define MBEDTLS_DES_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100384//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300385//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_MD5_ALT
387//#define MBEDTLS_RIPEMD160_ALT
388//#define MBEDTLS_SHA1_ALT
389//#define MBEDTLS_SHA256_ALT
390//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000391
Paul Bakker90995b52013-06-24 19:20:35 +0200392/**
TRodziewicz75628d52021-06-18 12:56:27 +0200393 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200394 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200395 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100396 * alternate core implementation of symmetric crypto or hash function. Keep in
397 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200399 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200401 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200402 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403 * no longer provide the mbedtls_sha1_process() function, but it will still provide
404 * the other function (using your mbedtls_sha1_process() function) and the definition
405 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200406 * with this definition.
407 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200408 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100409 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
410 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200411 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200412 * Uncomment a macro to enable alternate implementation of the corresponding
413 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100414 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200415 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100416 * constitutes a security risk. If possible, we recommend avoiding
417 * dependencies on them, and considering stronger message digests
418 * and ciphers instead.
419 *
Janos Follath1231d212019-01-07 15:01:32 +0000420 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
421 * enabled, then the deterministic ECDH signature functions pass the
422 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
423 * alternative implementations should use the RNG only for generating
424 * the ephemeral key and nothing else. If this is not possible, then
425 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200426 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000427 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200428 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200429//#define MBEDTLS_MD5_PROCESS_ALT
430//#define MBEDTLS_RIPEMD160_PROCESS_ALT
431//#define MBEDTLS_SHA1_PROCESS_ALT
432//#define MBEDTLS_SHA256_PROCESS_ALT
433//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200434//#define MBEDTLS_DES_SETKEY_ALT
435//#define MBEDTLS_DES_CRYPT_ECB_ALT
436//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200437//#define MBEDTLS_AES_SETKEY_ENC_ALT
438//#define MBEDTLS_AES_SETKEY_DEC_ALT
439//#define MBEDTLS_AES_ENCRYPT_ALT
440//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300441//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300442//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300443//#define MBEDTLS_ECDSA_VERIFY_ALT
444//#define MBEDTLS_ECDSA_SIGN_ALT
445//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200446
447/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200448 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200449 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200450 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200451 * hardware entropy collector.
452 *
453 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000454 * prototype as declared in library/entropy_poll.h, and accept NULL as first
455 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200456 *
457 * Uncomment to use your own hardware entropy collector.
458 */
459//#define MBEDTLS_ENTROPY_HARDWARE_ALT
460
461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000463 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100464 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000465 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100466 * Uncomment this macro to use precomputed AES tables stored in ROM.
467 * Comment this macro to generate AES tables in RAM at runtime.
468 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100469 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
470 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100471 * initialization time before the first AES operation can be performed.
472 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
473 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
474 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100475 *
476 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000479
480/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100481 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200482 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100483 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200484 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100485 * Uncommenting this macro omits 75% of the AES tables from
486 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
487 * by computing their values on the fly during operations
488 * (the tables are entry-wise rotations of one another).
489 *
490 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100491 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100492 * runtime. Specifically, one has to compare 4 accesses within
493 * different tables to 4 accesses with additional arithmetic
494 * operations within the same table. The performance gain/loss
495 * depends on the system and memory details.
496 *
497 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200498 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100499//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200500
501/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800502 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
503 *
504 * Use only 128-bit keys in AES operations to save ROM.
505 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800506 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800507 * or 256-bit keys.
508 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800509 * Uncommenting this macro reduces the size of AES code by ~300 bytes
510 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800511 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800512 * Module: library/aes.c
513 *
514 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800515 */
516//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
517
Gilles Peskinea8861e02023-09-05 20:20:51 +0200518/*
519 * Disable plain C implementation for AES.
520 *
521 * When the plain C implementation is enabled, and an implementation using a
522 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
523 * detection will be used to select between them.
524 *
525 * If only one implementation is present, runtime detection will not be used.
526 * This configuration will crash at runtime if running on a CPU without the
527 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
528 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
529 */
530//#define MBEDTLS_AES_USE_HARDWARE_ONLY
531
Arto Kinnunen732ca322023-04-14 14:26:10 +0800532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200533 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200534 *
535 * Use less ROM for the Camellia implementation (saves about 768 bytes).
536 *
537 * Uncomment this macro to use less memory for Camellia.
538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200540
541/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200542 * \def MBEDTLS_CHECK_RETURN_WARNING
543 *
544 * If this macro is defined, emit a compile-time warning if application code
545 * calls a function without checking its return value, but the return value
546 * should generally be checked in portable applications.
547 *
548 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
549 * implemented. Otherwise this option has no effect.
550 *
551 * Uncomment to get warnings on using fallible functions without checking
552 * their return value.
553 *
554 * \note This feature is a work in progress.
555 * Warnings will be added to more functions in the future.
556 *
557 * \note A few functions are considered critical, and ignoring the return
558 * value of these functions will trigger a warning even if this
559 * macro is not defined. To completely disable return value check
560 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
561 */
562//#define MBEDTLS_CHECK_RETURN_WARNING
563
564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200566 *
567 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200570
571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000573 *
574 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000577
578/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000580 *
581 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000584
585/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100586 * \def MBEDTLS_CIPHER_MODE_OFB
587 *
588 * Enable Output Feedback mode (OFB) for symmetric ciphers.
589 */
590#define MBEDTLS_CIPHER_MODE_OFB
591
592/**
593 * \def MBEDTLS_CIPHER_MODE_XTS
594 *
595 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
596 */
597#define MBEDTLS_CIPHER_MODE_XTS
598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000601 *
602 * Enable NULL cipher.
603 * Warning: Only do so when you know what you are doing. This allows for
604 * encryption or channels without any security!
605 *
Ronald Croncee42702021-04-26 11:34:44 +0200606 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
608 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
609 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
610 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
611 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
612 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
613 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
614 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
615 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
616 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
617 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
618 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
619 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
620 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
621 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
622 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
623 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
624 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
625 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000626 *
627 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200629//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000630
631/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100632 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200633 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100634 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
635 * specific padding modes in the cipher layer with cipher modes that support
636 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200637 *
638 * If you disable all padding modes, only full blocks can be used with CBC.
639 *
640 * Enable padding modes in the cipher layer.
641 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642#define MBEDTLS_CIPHER_PADDING_PKCS7
643#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
644#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
645#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200646
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200647/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
648 *
649 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800650 * Without this, CTR_DRBG uses a 256-bit key
651 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200652 */
653//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
654
Paul Bakker48e93c82013-08-14 12:21:18 +0200655/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200656 * Enable the verified implementations of ECDH primitives from Project Everest
657 * (currently only Curve25519). This feature changes the layout of ECDH
658 * contexts and therefore is a compatibility break for applications that access
659 * fields of a mbedtls_ecdh_context structure directly. See also
660 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000661 *
662 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
663 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200664 */
665//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
666
667/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100668 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200669 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100670 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
671 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200672 *
673 * Comment macros to disable the curve and functions for it
674 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200675/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
677#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
678#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
679#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
680#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
681#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
682#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
683#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
684#define MBEDTLS_ECP_DP_BP256R1_ENABLED
685#define MBEDTLS_ECP_DP_BP384R1_ENABLED
686#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200687/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200688#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000689#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200690
691/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200692 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200693 *
694 * Enable specific 'modulo p' routines for each NIST prime.
695 * Depending on the prime and architecture, makes operations 4 to 8 times
696 * faster on the corresponding curve.
697 *
698 * Comment this macro to disable NIST curves optimisation.
699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200701
702/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200703 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100704 *
705 * Enable "non-blocking" ECC operations that can return early and be resumed.
706 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200707 * This allows various functions to pause by returning
708 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
709 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
710 * order to further progress and eventually complete their operation. This is
711 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
712 * number of ECC operations a function may perform before pausing; see
713 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100714 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200715 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200716 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100717 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100718 * This option:
719 * - Adds xxx_restartable() variants of existing operations in the
720 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100721 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
722 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100723 * - ECDSA: signature generation & verification;
724 * - PK: signature generation & verification;
725 * - X509: certificate chain verification.
726 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
727 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
728 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
729 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000730 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100731 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100732 * - verification of the server's key exchange signature;
733 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100734 * - generation of the client's signature if client authentication is used,
735 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100736 *
737 * \note In the cases above, the usual SSL/TLS functions, such as
738 * mbedtls_ssl_handshake(), can now return
739 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200740 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100741 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
742 * restartable operations in PK, X.509 and TLS (see above) are not
743 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100744 * PSA, and are not restartable. These are temporary limitations that
745 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200746 *
Ron Eldor19779c42018-11-05 16:58:13 +0200747 * \note This option only works with the default software implementation of
748 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100749 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100750 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100751 * Requires: MBEDTLS_ECP_C
752 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100753 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100754 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200755//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100756
757/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200758 * Uncomment to enable using new bignum code in the ECC modules.
759 *
760 * \warning This is currently experimental, incomplete and therefore should not
761 * be used in production.
762 */
763//#define MBEDTLS_ECP_WITH_MPI_UINT
764
765/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100767 *
768 * Enable deterministic ECDSA (RFC 6979).
769 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
770 * may result in a compromise of the long-term signing key. This is avoided by
771 * the deterministic variant.
772 *
John Durkop36a82e52020-10-26 09:39:05 -0700773 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100774 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100775 * Comment this macro to disable deterministic ECDSA.
776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100778
779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200781 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200782 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200783 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 * This enables the following ciphersuites (if other requisites are
785 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
787 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
788 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
789 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
790 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
791 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
792 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
793 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
794 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
795 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200798
799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200802 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200805 *
806 * This enables the following ciphersuites (if other requisites are
807 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
809 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
810 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
811 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
812 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
813 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
814 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
815 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
816 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
817 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100818 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100819 * \warning Using DHE constitutes a security risk as it
820 * is not possible to validate custom DH parameters.
821 * If possible, it is recommended users should consider
822 * preferring other methods of key exchange.
823 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100824 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827
828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200830 *
831 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
832 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200833 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200834 *
835 * This enables the following ciphersuites (if other requisites are
836 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
838 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
839 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
840 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
841 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
842 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200843 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200845
846/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200848 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200849 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200850 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
852 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200853 *
854 * This enables the following ciphersuites (if other requisites are
855 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
857 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
858 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
859 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
860 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
861 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
862 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
863 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
864 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
865 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868
869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200872 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200873 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
875 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200876 *
877 * This enables the following ciphersuites (if other requisites are
878 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
880 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
881 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
882 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
883 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
884 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
885 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
886 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
887 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
888 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
889 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
890 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200891 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893
894/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200897 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
900 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
902 * This enables the following ciphersuites (if other requisites are
903 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
905 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
906 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
907 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
908 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
909 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
910 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
911 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
912 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
913 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
914 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
915 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100916 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100917 * \warning Using DHE constitutes a security risk as it
918 * is not possible to validate custom DH parameters.
919 * If possible, it is recommended users should consider
920 * preferring other methods of key exchange.
921 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100922 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200925
926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200928 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200929 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200930 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200931 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
932 * MBEDTLS_RSA_C
933 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200935 *
936 * This enables the following ciphersuites (if other requisites are
937 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
939 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
940 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
941 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
942 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
943 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
944 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
945 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
946 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
947 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200950
951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200953 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200954 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200955 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200956 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
957 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
958 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200959 *
960 * This enables the following ciphersuites (if other requisites are
961 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
963 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
964 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
965 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
967 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
968 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
970 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
971 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200974
975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100977 *
978 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
979 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200980 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
981 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
982 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100983 *
984 * This enables the following ciphersuites (if other requisites are
985 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
987 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
988 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
989 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
990 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
991 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
992 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
993 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
994 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
995 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001001 *
1002 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1003 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001004 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1005 * MBEDTLS_RSA_C
1006 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001007 *
1008 * This enables the following ciphersuites (if other requisites are
1009 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001010 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1011 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1012 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1013 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1014 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1015 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1016 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1017 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1018 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1019 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001022
1023/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001024 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1025 *
1026 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1027 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001028 * \warning This is currently experimental. EC J-PAKE support is based on the
1029 * Thread v1.0.0 specification; incompatible changes to the specification
1030 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001031 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001032 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001033 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001034 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1035 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001036 * \warning If SHA-256 is provided only by a PSA driver, you must call
1037 * psa_crypto_init() before the first hanshake (even if
1038 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1039 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001040 * This enables the following ciphersuites (if other requisites are
1041 * enabled as well):
1042 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1043 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001044//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001048 *
1049 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1050 * RFC 5915 and RFC 5480.
1051 *
1052 * Currently this means parsing the SpecifiedECDomain choice of EC
1053 * parameters (only known groups are supported, not arbitrary domains, to
1054 * avoid validation issues).
1055 *
1056 * Disable if you only need to support RFC 5915 + 5480 key formats.
1057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001059
1060/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001061 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1062 *
1063 * Enable the support for parsing public keys of type Short Weierstrass
1064 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001065 * compressed point format. This parsing is done through ECP module's functions.
1066 *
1067 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1068 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1069 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001070 */
1071#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1072
1073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001075 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * Enable a dummy error function to make use of mbedtls_strerror() in
1077 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1078 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001079 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1081 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001082 *
1083 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001087
1088/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001090 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001091 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001092 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001096
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001097/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001099 *
1100 * Enable functions that use the filesystem.
1101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001103
1104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001106 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001107 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001108 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001109 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001110 * application.
1111 *
1112 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001113 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001115
1116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001118 *
1119 * Do not use built-in platform entropy functions.
1120 * This is useful if your platform does not support
1121 * standards like the /dev/urandom or Windows CryptoAPI.
1122 *
1123 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001126
1127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001129 *
1130 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1131 * default SHA-512 based one (if both are available).
1132 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001133 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001134 *
1135 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1136 * if you have performance concerns.
1137 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138 * This option is only useful if both MBEDTLS_SHA256_C and
1139 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001142
1143/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001144 * \def MBEDTLS_ENTROPY_NV_SEED
1145 *
1146 * Enable the non-volatile (NV) seed file-based entropy source.
1147 * (Also enables the NV seed read/write functions in the platform layer)
1148 *
1149 * This is crucial (if not required) on systems that do not have a
1150 * cryptographic entropy source (in hardware or kernel) available.
1151 *
1152 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1153 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001154 * \note The read/write functions that are used by the entropy source are
1155 * determined in the platform layer, and can be modified at runtime and/or
1156 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1157 *
1158 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001159 * with regular fopen(), please make sure you make a seedfile with the
1160 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1161 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001162 * and written to or you will get an entropy source error! The default
1163 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1164 * bytes from the file.
1165 *
1166 * \note The entropy collector will write to the seed file before entropy is
1167 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001168 */
1169//#define MBEDTLS_ENTROPY_NV_SEED
1170
Ronald Cron71016a92020-08-28 19:01:50 +02001171/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001172 *
Ronald Cron71016a92020-08-28 19:01:50 +02001173 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001174 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001175 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1176 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001177 *
1178 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001179 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001180 */
Ronald Cron71016a92020-08-28 19:01:50 +02001181//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001182
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001185 *
1186 * Enable debugging of buffer allocator memory issues. Automatically prints
1187 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1188 * function for 'debug output' of allocated memory.
1189 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001191 *
1192 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001195
1196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001198 *
1199 * Include backtrace information with each allocated block.
1200 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001202 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001203 *
1204 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001207
1208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001209 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001210 *
1211 * Support external private RSA keys (eg from a HSM) in the PK layer.
1212 *
1213 * Comment this macro to disable support for external private RSA keys.
1214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001216
1217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001219 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001220 * Enable support for PKCS#1 v1.5 encoding.
1221 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001222 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001223 *
Paul Bakker48377d92013-08-30 12:06:24 +02001224 * This enables support for PKCS#1 v1.5 operations.
1225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001227
1228/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001230 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001231 * Enable support for PKCS#1 v2.1 encoding.
1232 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001233 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001234 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001235 * \warning If using a hash that is only provided by PSA drivers, you must
1236 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001237 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001238 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001241
Steven Cooreman6801f082021-02-19 17:21:22 +01001242/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1243 *
1244 * Enable support for platform built-in keys. If you enable this feature,
1245 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1246 * See the documentation of that function for more information.
1247 *
1248 * Built-in keys are typically derived from a hardware unique key or
1249 * stored in a secure element.
1250 *
1251 * Requires: MBEDTLS_PSA_CRYPTO_C.
1252 *
1253 * \warning This interface is experimental and may change or be removed
1254 * without notice.
1255 */
1256//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1257
Ronald Cron3768ac12021-01-26 16:58:00 +01001258/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1259 *
1260 * Enable support for PSA crypto client.
1261 *
1262 * \note This option allows to include the code necessary for a PSA
1263 * crypto client when the PSA crypto implementation is not included in
1264 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1265 * code to set and get PSA key attributes.
1266 * The development of PSA drivers partially relying on the library to
1267 * fulfill the hardware gaps is another possible usage of this option.
1268 *
1269 * \warning This interface is experimental and may change or be removed
1270 * without notice.
1271 */
1272//#define MBEDTLS_PSA_CRYPTO_CLIENT
1273
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001274/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1275 *
1276 * Make the PSA Crypto module use an external random generator provided
1277 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1278 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001279 * \note This random generator must deliver random numbers with cryptographic
1280 * quality and high performance. It must supply unpredictable numbers
1281 * with a uniform distribution. The implementation of this function
1282 * is responsible for ensuring that the random generator is seeded
1283 * with sufficient entropy. If you have a hardware TRNG which is slow
1284 * or delivers non-uniform output, declare it as an entropy source
1285 * with mbedtls_entropy_add_source() instead of enabling this option.
1286 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001287 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001288 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1289 * and define a function called mbedtls_psa_external_get_random()
1290 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001291 * ```
1292 * psa_status_t mbedtls_psa_external_get_random(
1293 * mbedtls_psa_external_random_context_t *context,
1294 * uint8_t *output, size_t output_size, size_t *output_length);
1295 * );
1296 * ```
1297 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001298 * The function must fill the \c output buffer with \c output_size bytes
1299 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001300 *
1301 * Requires: MBEDTLS_PSA_CRYPTO_C
1302 *
1303 * \warning If you enable this option, code that uses the PSA cryptography
1304 * interface will not use any of the entropy sources set up for
1305 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1306 * enables.
1307 *
1308 * \note This option is experimental and may be removed without notice.
1309 */
1310//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1311
Paul Bakker9dcc3222011-03-08 14:16:06 +00001312/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001313 * \def MBEDTLS_PSA_CRYPTO_SPM
1314 *
1315 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1316 * Partition Manager) integration which separates the code into two parts: a
1317 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1318 * Environment).
1319 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001320 * If you enable this option, your build environment must include a header
1321 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1322 * header files, or in another directory on the compiler's include search
1323 * path). Alternatively, your platform may customize the header
1324 * `psa/crypto_platform.h`, in which case it can skip or replace the
1325 * inclusion of `"crypto_spe.h"`.
1326 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001327 * Module: library/psa_crypto.c
1328 * Requires: MBEDTLS_PSA_CRYPTO_C
1329 *
1330 */
1331//#define MBEDTLS_PSA_CRYPTO_SPM
1332
1333/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001334 * Uncomment to enable p256-m. This is an alternative implementation of
1335 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1336 * Compared to the default implementation:
1337 *
1338 * - p256-m has a much smaller code size and RAM footprint.
1339 * - p256-m is only available via the PSA API. This includes the pk module
1340 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1341 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1342 * over the core arithmetic, or deterministic derivation of keys.
1343 *
1344 * We recommend enabling this option if your application uses the PSA API
1345 * and the only elliptic curve support it needs is ECDH and ECDSA over
1346 * SECP256R1.
1347 *
1348 * If you enable this option, you do not need to enable any ECC-related
1349 * MBEDTLS_xxx option. You do need to separately request support for the
1350 * cryptographic mechanisms through the PSA API:
1351 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1352 * configuration;
1353 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1354 * - #PSA_WANT_ECC_SECP_R1_256;
1355 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1356 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1357 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1358 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1359 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001360 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001361 * \note To benefit from the smaller code size of p256-m, make sure that you
1362 * do not enable any ECC-related option not supported by p256-m: this
1363 * would cause the built-in ECC implementation to be built as well, in
1364 * order to provide the required option.
1365 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001366 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1367 * SECP256R1 are disabled as they are not supported by this driver.
1368 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1369 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001370 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001371 */
1372//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1373
1374/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001375 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001376 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001377 * Enable support for entropy injection at first boot. This feature is
1378 * required on systems that do not have a built-in entropy source (TRNG).
1379 * This feature is currently not supported on systems that have a built-in
1380 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001381 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001382 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001383 *
1384 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001385//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001386
1387/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001388 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001389 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001390 * Assume all buffers passed to PSA functions are owned exclusively by the
1391 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001392 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001393 * This option may be enabled if all buffers passed to any PSA function reside
1394 * in memory that is accessible only to the PSA function during its execution.
1395 *
1396 * This option MUST be disabled whenever buffer arguments are in memory shared
1397 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001398 * across a trust boundary.
1399 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001400 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001401 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001402 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001403 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001404 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001405//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001406
1407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001409 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001410 * Do not use the Chinese Remainder Theorem
1411 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001412 *
1413 * Uncomment this macro to disable the use of CRT in RSA.
1414 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001416//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001417
1418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001420 *
1421 * Enable the checkup functions (*_self_test).
1422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001424
1425/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001426 * \def MBEDTLS_SHA256_SMALLER
1427 *
1428 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1429 * lower performance.
1430 *
Adam Wolf039080f2019-09-10 09:53:08 -05001431 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001432 * performance and size. This version optimizes more aggressively for size at
1433 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1434 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1435 * 30%.
1436 *
1437 * Uncomment to enable the smaller implementation of SHA256.
1438 */
1439//#define MBEDTLS_SHA256_SMALLER
1440
1441/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001442 * \def MBEDTLS_SHA512_SMALLER
1443 *
1444 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1445 * lower performance.
1446 *
1447 * Uncomment to enable the smaller implementation of SHA512.
1448 */
1449//#define MBEDTLS_SHA512_SMALLER
1450
1451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001453 *
1454 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001455 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001456 * with other servers, only debugging of failures is harder.
1457 *
1458 * The advantage of not sending alert messages, is that no information is given
1459 * about reasons for failures thus preventing adversaries of gaining intel.
1460 *
1461 * Enable sending of all alert messages
1462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001464
1465/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001466 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1467 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001468 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001469 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001470 * in the underlying transport. The CID functionality is described
1471 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001472 *
1473 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001474 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1475 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1476 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001477 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001478 * The maximum lengths of outgoing and incoming CIDs can be configured
1479 * through the options
1480 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1481 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1482 *
1483 * Requires: MBEDTLS_SSL_PROTO_DTLS
1484 *
1485 * Uncomment to enable the Connection ID extension.
1486 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001487#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1488
1489
1490/**
1491 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1492 *
1493 * Defines whether RFC 9146 (default) or the legacy version
1494 * (version draft-ietf-tls-dtls-connection-id-05,
1495 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1496 * is used.
1497 *
1498 * Set the value to 0 for the standard version, and
1499 * 1 for the legacy draft version.
1500 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001501 * \deprecated Support for the legacy version of the DTLS
1502 * Connection ID feature is deprecated. Please
1503 * switch to the standardized version defined
1504 * in RFC 9146 enabled by utilizing
1505 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1506 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1507 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001508 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1509 */
1510#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001511
1512/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001513 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1514 *
1515 * Enable asynchronous external private key operations in SSL. This allows
1516 * you to configure an SSL connection to call an external cryptographic
1517 * module to perform private key operations instead of performing the
1518 * operation inside the library.
1519 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001520 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001521 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001522//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001523
1524/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001525 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1526 *
1527 * Enable serialization of the TLS context structures, through use of the
1528 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1529 *
1530 * This pair of functions allows one side of a connection to serialize the
1531 * context associated with the connection, then free or re-use that context
1532 * while the serialized state is persisted elsewhere, and finally deserialize
1533 * that state to a live context for resuming read/write operations on the
1534 * connection. From a protocol perspective, the state of the connection is
1535 * unaffected, in particular this is entirely transparent to the peer.
1536 *
1537 * Note: this is distinct from TLS session resumption, which is part of the
1538 * protocol and fully visible by the peer. TLS session resumption enables
1539 * establishing new connections associated to a saved session with shorter,
1540 * lighter handshakes, while context serialization is a local optimization in
1541 * handling a single, potentially long-lived connection.
1542 *
1543 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1544 * saved after the handshake to allow for more efficient serialization, so if
1545 * you don't need this feature you'll save RAM by disabling it.
1546 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001547 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1548 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001549 * Comment to disable the context serialization APIs.
1550 */
1551#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1552
1553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001554 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001555 *
1556 * Enable the debug messages in SSL module for all issues.
1557 * Debug messages have been disabled in some places to prevent timing
1558 * attacks due to (unbalanced) debugging function calls.
1559 *
1560 * If you need all error reporting you should enable this during debugging,
1561 * but remove this for production servers that should log as well.
1562 *
1563 * Uncomment this macro to report all debug messages on errors introducing
1564 * a timing side-channel.
1565 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001569/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001570 *
1571 * Enable support for Encrypt-then-MAC, RFC 7366.
1572 *
1573 * This allows peers that both support it to use a more robust protection for
1574 * ciphersuites using CBC, providing deep resistance against timing attacks
1575 * on the padding or underlying cipher.
1576 *
1577 * This only affects CBC ciphersuites, and is useless if none is defined.
1578 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001579 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001580 *
1581 * Comment this macro to disable support for Encrypt-then-MAC
1582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001586 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001587 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1588 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001589 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001590 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001591 * attacks, but it is recommended to always use it (even if you disable
1592 * renegotiation), since it actually fixes a more fundamental issue in the
1593 * original SSL/TLS design, and has implications beyond Triple Handshake.
1594 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001595 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001596 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001597 * Comment this macro to disable support for Extended Master Secret.
1598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001600
Paul Bakkerd66f0702013-01-31 16:57:45 +01001601/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001602 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1603 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001604 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001605 * giving access to the peer's certificate after completion of the handshake.
1606 *
1607 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1608 * recommended to disable this option for reduced RAM usage.
1609 *
1610 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1611 * defined, but always returns \c NULL.
1612 *
1613 * \note This option has no influence on the protection against the
1614 * triple handshake attack. Even if it is disabled, Mbed TLS will
1615 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001616 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001617 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001618 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001619 *
1620 * Comment this macro to disable storing the peer's certificate
1621 * after the handshake.
1622 */
1623#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1624
1625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001627 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001628 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001629 *
1630 * The two main uses of renegotiation are (1) refresh keys on long-lived
1631 * connections and (2) client authentication after the initial handshake.
1632 * If you don't need renegotiation, it's probably better to disable it, since
1633 * it has been associated with security issues in the past and is easy to
1634 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001635 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001636 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1637 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001638 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001639 *
1640 * \note Even if this option is disabled, both client and server are aware
1641 * of the Renegotiation Indication Extension (RFC 5746) used to
1642 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1643 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1644 * configuration of this extension).
1645 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001648
1649/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001651 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001652 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001653 *
1654 * Comment this macro to disable support for the max_fragment_length extension
1655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001657
1658/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001659 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1660 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001661 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001662 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001663 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1664 *
1665 * Uncomment this macro to enable support for the record_size_limit extension
1666 */
1667//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1668
1669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001670 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001671 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001672 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001673 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001674 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001675 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1676 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001677 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001678 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001679 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001680 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1681 * are only provided by PSA drivers, you must call psa_crypto_init() before
1682 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001683 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001684 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001687
1688/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001689 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001690 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001691 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001692 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001693 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001694 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001695 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001696 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001697 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001698 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001699 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1700 * directly performed by TLS 1.3 code. As a consequence, you must
1701 * call psa_crypto_init() before the first TLS 1.3 handshake.
1702 *
1703 * \note Cryptographic operations performed indirectly via another module
1704 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1705 * running handshake hash) only use PSA crypto if
1706 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001707 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001708 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001709 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001710#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001711
1712/**
Ronald Cronab65c522021-11-24 10:47:20 +01001713 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1714 *
1715 * Enable TLS 1.3 middlebox compatibility mode.
1716 *
1717 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1718 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1719 * expecting TLS 1.2 traffic.
1720 *
1721 * Turning on the compatibility mode comes at the cost of a few added bytes
1722 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1723 * that don't use it. Therefore, unless transmission bandwidth is critical and
1724 * you know that middlebox compatibility issues won't occur, it is therefore
1725 * recommended to set this option.
1726 *
1727 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001728 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1729 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001730 *
1731 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001732#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001733
1734/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001735 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1736 *
1737 * Enable TLS 1.3 PSK key exchange mode.
1738 *
1739 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1740 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1741 * effect on the build.
1742 *
1743 */
1744#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1745
1746/**
1747 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1748 *
1749 * Enable TLS 1.3 ephemeral key exchange mode.
1750 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001751 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001752 * MBEDTLS_X509_CRT_PARSE_C
1753 * and at least one of:
1754 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1755 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001756 *
1757 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1758 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1759 * effect on the build.
1760 *
1761 */
1762#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1763
1764/**
1765 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1766 *
1767 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1768 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001769 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001770 *
1771 * Comment to disable support for the PSK ephemeral key exchange mode in
1772 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1773 * have any effect on the build.
1774 *
1775 */
1776#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1777
1778/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001779 * \def MBEDTLS_SSL_EARLY_DATA
1780 *
1781 * Enable support for RFC 8446 TLS 1.3 early data.
1782 *
1783 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1784 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1785 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1786 *
1787 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1788 * is not enabled, this option does not have any effect on the build.
1789 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001790 * \note The maximum amount of early data can be set with
1791 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1792 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001794//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001795
1796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001798 *
1799 * Enable support for DTLS (all available versions).
1800 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001801 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001802 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001803 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001804 *
1805 * Comment this macro to disable support for DTLS
1806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001811 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001812 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001813 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001814 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001817
1818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001820 *
1821 * Enable support for the anti-replay mechanism in DTLS.
1822 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823 * Requires: MBEDTLS_SSL_TLS_C
1824 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001825 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001826 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001827 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001828 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001829 * Comment this to disable anti-replay in DTLS.
1830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001832
1833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001835 *
1836 * Enable support for HelloVerifyRequest on DTLS servers.
1837 *
1838 * This feature is highly recommended to prevent DTLS servers being used as
1839 * amplifiers in DoS attacks against other hosts. It should always be enabled
1840 * unless you know for sure amplification cannot be a problem in the
1841 * environment in which your server operates.
1842 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001843 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001844 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001845 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001846 *
1847 * Comment this to disable support for HelloVerifyRequest.
1848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001849#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001850
1851/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001852 * \def MBEDTLS_SSL_DTLS_SRTP
1853 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001854 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001855 * through the use_srtp extension.
1856 *
1857 * \note This feature provides the minimum functionality required
1858 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1859 * the associated SRTP packet protection key material.
1860 * In particular, the SRTP packet protection itself, as well as the
1861 * demultiplexing of RTP and DTLS packets at the datagram layer
1862 * (see Section 5 of RFC 5764), are not handled by this feature.
1863 * Instead, after successful completion of a handshake negotiating
1864 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001865 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001866 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1867 * (this is implemented in the SSL example programs).
1868 * The resulting key should then be passed to an SRTP stack.
1869 *
1870 * Setting this option enables the runtime API
1871 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1872 * through which the supported DTLS-SRTP protection
1873 * profiles can be configured. You must call this API at
1874 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001875 *
1876 * Requires: MBEDTLS_SSL_PROTO_DTLS
1877 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001878 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001879 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001880//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001881
1882/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001883 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1884 *
1885 * Enable server-side support for clients that reconnect from the same port.
1886 *
1887 * Some clients unexpectedly close the connection and try to reconnect using the
1888 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001889 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001890 * flag enables that support.
1891 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001892 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001893 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001894 * Comment this to disable support for clients reusing the source port.
1895 */
1896#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1897
1898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001900 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001901 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001902 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001903 * session store remains the responsibility of the application, though).
1904 * Server-side, you also need to provide callbacks for writing and parsing
1905 * tickets, including authenticated encryption and key management. Example
1906 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001907 *
1908 * Comment this macro to disable support for SSL session tickets
1909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001914 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001915 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001916 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001918 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001919 * Comment this macro to disable support for server name indication in SSL
1920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001922
1923/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001924 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1925 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001926 * When this option is enabled, the SSL buffer will be resized automatically
1927 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001928 *
1929 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001930 */
1931//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1932
1933/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001934 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1935 *
1936 * Enable testing of the constant-flow nature of some sensitive functions with
1937 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001938 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001939 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001940 * This setting requires compiling with clang -fsanitize=memory. The test
1941 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001942 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001943 * \warning This macro is only used for extended testing; it is not considered
1944 * part of the library's API, so it may change or disappear at any time.
1945 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001946 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001947 */
1948//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1949
1950/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001951 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1952 *
1953 * Enable testing of the constant-flow nature of some sensitive functions with
1954 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001955 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001956 *
1957 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001958 * testing if the tests suites are run with valgrind's memcheck. This can be
1959 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1960 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001961 *
1962 * \warning This macro is only used for extended testing; it is not considered
1963 * part of the library's API, so it may change or disappear at any time.
1964 *
1965 * Uncomment to enable testing of the constant-flow nature of selected code.
1966 */
1967//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1968
1969/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001970 * \def MBEDTLS_TEST_HOOKS
1971 *
1972 * Enable features for invasive testing such as introspection functions and
1973 * hooks for fault injection. This enables additional unit tests.
1974 *
1975 * Merely enabling this feature should not change the behavior of the product.
1976 * It only adds new code, and new branching points where the default behavior
1977 * is the same as when this feature is disabled.
1978 * However, this feature increases the attack surface: there is an added
1979 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1980 * Therefore this feature must never be enabled in production.
1981 *
1982 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1983 * information.
1984 *
1985 * Uncomment to enable invasive tests.
1986 */
1987//#define MBEDTLS_TEST_HOOKS
1988
1989/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001991 *
1992 * Provide your own alternate threading implementation.
1993 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001995 *
1996 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001999
2000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002002 *
2003 * Enable the pthread wrapper layer for the threading layer.
2004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002006 *
2007 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002010
2011/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002012 * \def MBEDTLS_USE_PSA_CRYPTO
2013 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002014 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2015 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002016 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002017 * \note Development of this option is currently in progress, and parts of Mbed
2018 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002019 * will still continue to work as usual, so enabling this option should not
2020 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002021 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002022 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002023 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2024 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002025 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002026 * \note An important and desirable effect of this option is that it allows
2027 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2028 * 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 +02002029 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002030 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2031 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002032 *
2033 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002034 *
2035 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002036 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002037 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002039//#define MBEDTLS_USE_PSA_CRYPTO
2040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002042 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2043 *
John Durkop185764f2020-10-12 21:32:12 -07002044 * This setting allows support for cryptographic mechanisms through the PSA
2045 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002046 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002047 * When this option is disabled, the PSA API exposes the cryptographic
2048 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2049 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002050 *
2051 * When this option is enabled, the PSA API exposes the cryptographic
2052 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2053 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2054 * automatically enabled if required (i.e. if no PSA driver provides the
2055 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2056 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002057 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002058 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002059 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002060 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002061 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2062 * symbols is not completely finalized yet, and the configuration
2063 * tooling is not ideally adapted to having two separate configuration
2064 * files.
2065 * Future minor releases of Mbed TLS may make minor changes to those
2066 * symbols, but we will endeavor to provide a transition path.
2067 * Nonetheless, this option is considered mature enough to use in
2068 * production, as long as you accept that you may need to make
2069 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002070 */
2071//#define MBEDTLS_PSA_CRYPTO_CONFIG
2072
2073/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002074 * \def MBEDTLS_VERSION_FEATURES
2075 *
2076 * Allow run-time checking of compile-time enabled features. Thus allowing users
2077 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002078 * support via mbedtls_version_check_feature().
2079 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002080 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002081 *
2082 * Comment this to disable run-time checking and save ROM space
2083 */
2084#define MBEDTLS_VERSION_FEATURES
2085
2086/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002087 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2088 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002089 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002090 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2091 * the set of trusted certificates through a callback instead of a linked
2092 * list.
2093 *
2094 * This is useful for example in environments where a large number of trusted
2095 * certificates is present and storing them in a linked list isn't efficient
2096 * enough, or when the set of trusted certificates changes frequently.
2097 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002098 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002099 * `mbedtls_ssl_conf_ca_cb()` for more information.
2100 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002101 * Requires: MBEDTLS_X509_CRT_PARSE_C
2102 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002103 * Uncomment to enable trusted certificate callbacks.
2104 */
2105//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2106
2107/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002108 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002109 *
Chris Jones2c745862020-12-16 11:41:06 +00002110 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002111 *
Chris Jones2c745862020-12-16 11:41:06 +00002112 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002113 * and other functions/constants only used by these functions, thus reducing
2114 * the code footprint by several KB.
2115 */
Chris Jones2c745862020-12-16 11:41:06 +00002116//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002117
2118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002120 *
2121 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2122 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2123 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002124 * Requires: MBEDTLS_PKCS1_V21
2125 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002126 * Comment this macro to disallow using RSASSA-PSS in certificates.
2127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002129/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002130
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002131/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002132 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002133 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002134 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002135 * \{
2136 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002137
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002140 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002141 * Enable AES-NI support on x86-64 or x86-32.
2142 *
2143 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002144 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002145 * - GCC, x86-64, target not explicitly supporting AESNI:
2146 * requires MBEDTLS_HAVE_ASM.
2147 * - GCC, x86-32, target not explicitly supporting AESNI:
2148 * not supported.
2149 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2150 * For this assembly-less implementation, you must currently compile
2151 * `library/aesni.c` and `library/aes.c` with machine options to enable
2152 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2153 * `clang -maes -mpclmul`.
2154 * - Non-x86 targets: this option is silently ignored.
2155 * - Other compilers: this option is silently ignored.
2156 *
2157 * \note
2158 * Above, "GCC" includes compatible compilers such as Clang.
2159 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002160 *
2161 * Module: library/aesni.c
2162 * Caller: library/aes.c
2163 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002164 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002165 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002166 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002169
2170/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002171 * \def MBEDTLS_AESCE_C
2172 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002173 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002174 *
2175 * Module: library/aesce.c
2176 * Caller: library/aes.c
2177 *
Jerry Yuf015a932023-04-25 10:38:03 +08002178 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002179 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002180 * \warning Runtime detection only works on Linux. For non-Linux operating
2181 * system, Armv8-A Cryptographic Extensions must be supported by
2182 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002183 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002184 * \note Minimum compiler versions for this feature when targeting aarch64
2185 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2186 * Minimum compiler versions for this feature when targeting 32-bit
2187 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002188 *
2189 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2190 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002191 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002192 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002193 */
2194#define MBEDTLS_AESCE_C
2195
2196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002198 *
2199 * Enable the AES block cipher.
2200 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002201 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002202 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002203 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002204 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002205 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002206 * This module enables the following ciphersuites (if other requisites are
2207 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2209 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2210 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2211 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2212 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2213 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2214 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2215 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2216 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2217 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2218 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2219 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2220 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2221 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2222 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2223 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2224 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2225 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2226 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2227 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2228 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2229 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2230 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2231 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2232 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2233 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2234 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2235 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2237 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2238 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2239 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2240 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2241 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2242 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2243 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2244 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2245 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2246 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2247 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2248 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2249 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2250 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2251 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2252 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2253 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2254 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2255 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2256 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2257 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2258 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2259 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2260 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2261 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2262 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2263 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2264 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2265 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002266 *
Paul Bakkercff68422013-09-15 20:43:33 +02002267 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002270
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002273 *
2274 * Enable the generic ASN1 parser.
2275 *
2276 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002277 * Caller: library/x509.c
2278 * library/dhm.c
2279 * library/pkcs12.c
2280 * library/pkcs5.c
2281 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002284
2285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002287 *
2288 * Enable the generic ASN1 writer.
2289 *
2290 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002291 * Caller: library/ecdsa.c
2292 * library/pkwrite.c
2293 * library/x509_create.c
2294 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002295 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002298
2299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002301 *
2302 * Enable the Base64 module.
2303 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002304 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002305 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002307 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002310
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002311/**
Yanray Wange367e472023-10-31 17:23:04 +08002312 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2313 *
2314 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2315 *
2316 * \note This feature is incompatible with insecure block cipher,
2317 * MBEDTLS_DES_C, and cipher modes which always require decryption
2318 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002319 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2320 * this feature is incompatible with following supported PSA equivalence,
2321 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2322 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002323 *
2324 * Module: library/aes.c
2325 * library/aesce.c
2326 * library/aesni.c
2327 * library/aria.c
2328 * library/camellia.c
2329 * library/cipher.c
2330 */
2331//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2332
2333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002335 *
Paul Bakker9a736322012-11-14 12:39:52 +00002336 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002337 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002338 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002339 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002340 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002341 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002342 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002343 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002344 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002345 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002346 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002347 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002348 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002349 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002352
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002354 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002355 *
2356 * Enable the Camellia block cipher.
2357 *
Paul Bakker38119b12009-01-10 23:31:23 +00002358 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002359 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002360 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002361 * This module enables the following ciphersuites (if other requisites are
2362 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2365 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2367 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2370 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2372 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2373 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2374 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2375 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2376 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2377 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2378 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2379 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2380 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2381 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2382 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2383 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2384 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2385 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2386 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2387 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2388 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2389 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2390 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2391 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2392 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2393 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2394 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2395 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2396 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2397 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2398 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2399 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2400 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2401 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2402 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2403 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2404 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002407
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002408/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002409 * \def MBEDTLS_ARIA_C
2410 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002411 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002412 *
2413 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002414 * Caller: library/cipher.c
2415 *
2416 * This module enables the following ciphersuites (if other requisites are
2417 * enabled as well):
2418 *
2419 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2420 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2421 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2422 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2423 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2424 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2425 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2426 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2427 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2428 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2429 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2430 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2431 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2432 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2433 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2434 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2435 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2436 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2437 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2438 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2439 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2440 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2441 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2442 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2443 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2444 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2445 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2446 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2447 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2448 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2449 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2450 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2451 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2452 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2454 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2455 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2456 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002457 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002458#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002459
2460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002462 *
2463 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2464 *
2465 * Module: library/ccm.c
2466 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002467 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2468 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002469 *
2470 * This module enables the AES-CCM ciphersuites, if other requisites are
2471 * enabled as well.
2472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002474
2475/**
Daniel King34b822c2016-05-15 17:28:08 -03002476 * \def MBEDTLS_CHACHA20_C
2477 *
2478 * Enable the ChaCha20 stream cipher.
2479 *
2480 * Module: library/chacha20.c
2481 */
2482#define MBEDTLS_CHACHA20_C
2483
2484/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002485 * \def MBEDTLS_CHACHAPOLY_C
2486 *
2487 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2488 *
2489 * Module: library/chachapoly.c
2490 *
2491 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2492 */
2493#define MBEDTLS_CHACHAPOLY_C
2494
2495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002497 *
2498 * Enable the generic cipher layer.
2499 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002500 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002501 * Caller: library/ccm.c
2502 * library/cmac.c
2503 * library/gcm.c
2504 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002505 * library/pkcs12.c
2506 * library/pkcs5.c
2507 * library/psa_crypto_aead.c
2508 * library/psa_crypto_mac.c
2509 * library/ssl_ciphersuites.c
2510 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002511 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002512 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2513 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002514 *
2515 * Uncomment to enable generic cipher wrappers.
2516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002518
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002519/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002520 * \def MBEDTLS_CMAC_C
2521 *
Simon Butcher327398a2016-10-05 14:09:11 +01002522 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2523 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002524 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002525 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2526 * implementation of the CMAC algorithm is provided by an alternate
2527 * implementation, that alternate implementation may opt to not support
2528 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2529 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002530 * Module: library/cmac.c
2531 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002532 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002533 *
2534 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002535#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002536
2537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002539 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002540 * Enable the CTR_DRBG AES-based random generator.
2541 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002542 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002543 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002544 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2545 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2546 * is used.
2547 *
2548 * \warning When using PSA, the user should call `psa_crypto_init()` before
2549 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2550 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002551 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2552 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002553 * \note To achieve a 256-bit security strength with CTR_DRBG,
2554 * you must use AES-256 *and* use sufficient entropy.
2555 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002556 *
2557 * Module: library/ctr_drbg.c
2558 * Caller:
2559 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002560 * Requires: MBEDTLS_AES_C or
2561 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2562 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002563 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002564 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002567
2568/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570 *
2571 * Enable the debug functions.
2572 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002573 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002574 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002575 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002576 * library/ssl_tls12_*.c
2577 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002578 *
2579 * This module provides debugging functions.
2580 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002582
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002585 *
2586 * Enable the DES block cipher.
2587 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002588 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002589 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002590 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002591 *
Paul Bakkercff68422013-09-15 20:43:33 +02002592 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002593 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002594 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002595 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002598
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002601 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002602 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002603 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002604 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002605 * Caller: library/ssl_tls.c
2606 * library/ssl*_client.c
2607 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002608 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002609 * This module is used by the following key exchanges:
2610 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002611 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002612 * \warning Using DHE constitutes a security risk as it
2613 * is not possible to validate custom DH parameters.
2614 * If possible, it is recommended users should consider
2615 * preferring other methods of key exchange.
2616 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002617 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002620
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002621/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002623 *
2624 * Enable the elliptic curve Diffie-Hellman library.
2625 *
2626 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002627 * Caller: library/psa_crypto.c
2628 * library/ssl_tls.c
2629 * library/ssl*_client.c
2630 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002631 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002632 * This module is used by the following key exchanges:
2633 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002634 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002638
2639/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002641 *
2642 * Enable the elliptic curve DSA library.
2643 *
2644 * Module: library/ecdsa.c
2645 * Caller:
2646 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002647 * This module is used by the following key exchanges:
2648 * ECDHE-ECDSA
2649 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002650 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2651 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2652 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002655
2656/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002657 * \def MBEDTLS_ECJPAKE_C
2658 *
2659 * Enable the elliptic curve J-PAKE library.
2660 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002661 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2662 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002663 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002664 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002665 * Module: library/ecjpake.c
2666 * Caller:
2667 *
2668 * This module is used by the following key exchanges:
2669 * ECJPAKE
2670 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002671 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002672 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002673 * \warning If using a hash that is only provided by PSA drivers, you must
2674 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002675 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002676#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002677
2678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002680 *
2681 * Enable the elliptic curve over GF(p) library.
2682 *
2683 * Module: library/ecp.c
2684 * Caller: library/ecdh.c
2685 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002686 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002687 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002691
2692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002694 *
2695 * Enable the platform-specific entropy code.
2696 *
2697 * Module: library/entropy.c
2698 * Caller:
2699 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002701 *
2702 * This module provides a generic entropy pool
2703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002705
2706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002708 *
2709 * Enable error code to error string conversion.
2710 *
2711 * Module: library/error.c
2712 * Caller:
2713 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002717
2718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002720 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002721 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002722 *
2723 * Module: library/gcm.c
2724 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002725 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2726 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002727 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002728 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2729 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002730 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002732
2733/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002734 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002735 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002736 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002737 * Can significantly increase throughput on systems without GCM hardware
2738 * acceleration (e.g., AESNI, AESCE).
2739 *
Matthias Schulz78266782024-02-08 13:54:48 +01002740 * The mbedtls_gcm_context size will increase by 3840 bytes.
2741 * The code size will increase by roughly 344 bytes.
2742 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002743 * Module: library/gcm.c
2744 *
2745 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002746 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002747//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002748
2749/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002750 * \def MBEDTLS_HKDF_C
2751 *
2752 * Enable the HKDF algorithm (RFC 5869).
2753 *
2754 * Module: library/hkdf.c
2755 * Caller:
2756 *
2757 * Requires: MBEDTLS_MD_C
2758 *
2759 * This module adds support for the Hashed Message Authentication Code
2760 * (HMAC)-based key derivation function (HKDF).
2761 */
2762#define MBEDTLS_HKDF_C
2763
2764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002766 *
2767 * Enable the HMAC_DRBG random generator.
2768 *
2769 * Module: library/hmac_drbg.c
2770 * Caller:
2771 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002773 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002774 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002777
2778/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002779 * \def MBEDTLS_LMS_C
2780 *
2781 * Enable the LMS stateful-hash asymmetric signature algorithm.
2782 *
2783 * Module: library/lms.c
2784 * Caller:
2785 *
Raef Colesab4f8742022-09-01 12:24:31 +01002786 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002787 *
Raef Colesab4f8742022-09-01 12:24:31 +01002788 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002789 */
2790#define MBEDTLS_LMS_C
2791
2792/**
Raef Colesab4f8742022-09-01 12:24:31 +01002793 * \def MBEDTLS_LMS_PRIVATE
2794 *
2795 * Enable LMS private-key operations and signing code. Functions enabled by this
2796 * option are experimental, and should not be used in production.
2797 *
2798 * Requires: MBEDTLS_LMS_C
2799 *
2800 * Uncomment to enable the LMS signature algorithm and private key operations.
2801 */
Raef Coles5127e852022-10-07 10:35:56 +01002802//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002803
2804/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002805 * \def MBEDTLS_NIST_KW_C
2806 *
2807 * Enable the Key Wrapping mode for 128-bit block ciphers,
2808 * as defined in NIST SP 800-38F. Only KW and KWP modes
2809 * are supported. At the moment, only AES is approved by NIST.
2810 *
2811 * Module: library/nist_kw.c
2812 *
2813 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2814 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002815#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002816
2817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002819 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002820 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002821 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002822 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2823 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002824 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002825 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002826 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002827 * Caller: library/constant_time.c
2828 * library/ecdsa.c
2829 * library/ecjpake.c
2830 * library/hkdf.c
2831 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002832 * library/pk.c
2833 * library/pkcs5.c
2834 * library/pkcs12.c
2835 * library/psa_crypto_ecp.c
2836 * library/psa_crypto_rsa.c
2837 * library/rsa.c
2838 * library/ssl_cookie.c
2839 * library/ssl_msg.c
2840 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002841 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002842 * library/x509_crt.c
2843 * library/x509write_crt.c
2844 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002845 *
2846 * Uncomment to enable generic message digest wrappers.
2847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002849
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002850/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002852 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002853 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002854 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002855 * Module: library/md5.c
2856 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002857 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002858 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002859 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002860 * This module is required for TLS 1.2 depending on the handshake parameters.
2861 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2862 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002863 *
2864 * \warning MD5 is considered a weak message digest and its use constitutes a
2865 * security risk. If possible, we recommend avoiding dependencies on
2866 * it, and considering stronger message digests instead.
2867 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002870
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002873 *
2874 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002875 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002876 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002877 *
2878 * Module: library/memory_buffer_alloc.c
2879 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002880 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002881 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002882 *
2883 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002884 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002886
2887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002889 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002890 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2891 *
Simon Butcherd567a232016-03-09 20:19:21 +00002892 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2893 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002894 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002895 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002896 * \note See also our Knowledge Base article about porting to a new
2897 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002898 * 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 +00002899 *
Andres AG788aa4a2016-09-14 14:32:09 +01002900 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002901 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002902 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002903 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002905
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002908 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002909 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002910 *
2911 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002912 * Caller: library/asn1write.c
2913 * library/pkcs5.c
2914 * library/pkparse.c
2915 * library/pkwrite.c
2916 * library/rsa.c
2917 * library/x509.c
2918 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002919 * library/x509_crl.c
2920 * library/x509_crt.c
2921 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002922 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002923 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002924 *
2925 * This modules translates between OIDs and internal values.
2926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002928
2929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002931 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002932 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002933 *
2934 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002935 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002936 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002937 * library/x509_crl.c
2938 * library/x509_crt.c
2939 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002940 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002942 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2943 *
2944 * \warning When parsing password-protected files, if MD5 is provided only by
2945 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002946 *
Paul Bakkercff68422013-09-15 20:43:33 +02002947 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002950
2951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002953 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002954 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002955 *
2956 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002957 * Caller: library/pkwrite.c
2958 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002959 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002960 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002962 *
2963 * This modules adds support for encoding / writing PEM files.
2964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002966
2967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002969 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002970 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002971 *
2972 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002973 * Caller: library/psa_crypto_rsa.c
2974 * library/ssl_tls.c
2975 * library/ssl*_client.c
2976 * library/ssl*_server.c
2977 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002978 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002979 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002980 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002981 * Uncomment to enable generic public key wrappers.
2982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002984
2985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002987 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002988 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002989 *
2990 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002991 * Caller: library/x509_crt.c
2992 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002993 *
Yanray Wang072a0682023-12-05 10:53:04 +08002994 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002995 *
2996 * Uncomment to enable generic public key parse functions.
2997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002999
3000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003002 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003003 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003004 *
3005 * Module: library/pkwrite.c
3006 * Caller: library/x509write.c
3007 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003008 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003009 *
3010 * Uncomment to enable generic public key write functions.
3011 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003013
3014/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003016 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003017 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003018 *
3019 * Module: library/pkcs5.c
3020 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003021 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003022 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003023 * \warning If using a hash that is only provided by PSA drivers, you must
3024 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003025 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003026 * This module adds support for the PKCS#5 functions.
3027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003029
3030/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003031 * \def MBEDTLS_PKCS7_C
3032 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003033 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003034 * RFC Link - https://tools.ietf.org/html/rfc2315
3035 *
3036 * Module: library/pkcs7.c
3037 *
3038 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003039 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3040 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003041 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003042 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003043 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003044#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003045
3046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003048 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003049 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003050 * Adds algorithms for parsing PKCS#8 encrypted private keys
3051 *
3052 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003053 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003054 *
Valerio Settie98ad592023-12-28 10:42:12 +01003055 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3056 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003057 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003058 * \warning If using a hash that is only provided by PSA drivers, you must
3059 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003060 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003061 * This module enables PKCS#12 functions.
3062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003064
3065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003067 *
3068 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003069 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3072 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003073 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003074 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003075 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003076 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003077 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003078 * Module: library/platform.c
3079 * Caller: Most other .c files
3080 *
3081 * This module enables abstraction of common (libc) functions.
3082 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003083#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003084
3085/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003086 * \def MBEDTLS_POLY1305_C
3087 *
3088 * Enable the Poly1305 MAC algorithm.
3089 *
3090 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003091 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003092 */
3093#define MBEDTLS_POLY1305_C
3094
3095/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003096 * \def MBEDTLS_PSA_CRYPTO_C
3097 *
3098 * Enable the Platform Security Architecture cryptography API.
3099 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003100 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003101 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003102 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003103 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003104 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3105 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3106 * is enabled in PSA (unless it's fully accelerated, see
3107 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003108 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003109#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003110
3111/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003112 * \def MBEDTLS_PSA_CRYPTO_SE_C
3113 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003114 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003115 * cryptography API.
3116 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003117 * \deprecated This feature is deprecated. Please switch to the PSA driver
3118 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003119 *
Ryan Everett32a64582024-03-05 18:16:18 +00003120 * \warning This feature is not thread-safe, and should not be used in a
3121 * multi-threaded environment.
3122 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003123 * Module: library/psa_crypto_se.c
3124 *
3125 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3126 *
3127 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003128//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003129
3130/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003131 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3132 *
3133 * Enable the Platform Security Architecture persistent key storage.
3134 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003135 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003136 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003137 * Requires: MBEDTLS_PSA_CRYPTO_C,
3138 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3139 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003140 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003141#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003142
3143/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003144 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003145 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003146 * Enable the emulation of the Platform Security Architecture
3147 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003148 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003149 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003150 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003151 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003152 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003153#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003154
3155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003156 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003157 *
3158 * Enable the RIPEMD-160 hash algorithm.
3159 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003160 * Module: library/ripemd160.c
3161 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003162 *
3163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003165
3166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003168 *
3169 * Enable the RSA public-key cryptosystem.
3170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003171 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003172 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003173 * Caller: library/pk.c
3174 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003175 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003176 * library/ssl*_client.c
3177 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003178 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003179 * This module is used by the following key exchanges:
3180 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003181 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003185
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003188 *
3189 * Enable the SHA1 cryptographic hash algorithm.
3190 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003191 * Module: library/sha1.c
3192 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003193 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003194 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003195 * This module is required for TLS 1.2 depending on the handshake parameters,
3196 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003197 *
3198 * \warning SHA-1 is considered a weak message digest and its use constitutes
3199 * a security risk. If possible, we recommend avoiding dependencies
3200 * on it, and considering stronger message digests instead.
3201 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003204
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003205/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003206 * \def MBEDTLS_SHA224_C
3207 *
3208 * Enable the SHA-224 cryptographic hash algorithm.
3209 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003210 * Module: library/sha256.c
3211 * Caller: library/md.c
3212 * library/ssl_cookie.c
3213 *
3214 * This module adds support for SHA-224.
3215 */
3216#define MBEDTLS_SHA224_C
3217
3218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003220 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003221 * Enable the SHA-256 cryptographic hash algorithm.
3222 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003223 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003224 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003225 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003226 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003227 * library/ssl*_client.c
3228 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003229 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003230 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003231 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003234
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003235/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003236 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003237 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003238 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3239 * with the ARMv8 cryptographic extensions if they are available at runtime.
3240 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003241 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003242 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003243 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003244 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003245 * \note Minimum compiler versions for this feature are Clang 4.0,
3246 * armclang 6.6 or GCC 6.0.
3247 *
3248 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3249 * armclang <= 6.9
3250 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003251 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3252 * That name is deprecated, but may still be used as an alternative form for this
3253 * option.
3254 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003255 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3256 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003257 *
3258 * Requires: MBEDTLS_SHA256_C.
3259 *
3260 * Module: library/sha256.c
3261 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003262 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003263 * and use them if available.
3264 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003265//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003266
Dave Rodgmand85277c2023-10-13 09:22:54 +01003267/**
3268 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3269 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003270 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003271 * This name is now deprecated, but may still be used as an alternative form for
3272 * this option.
3273 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003274//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3275
3276/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003277 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003278 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003279 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3280 * with the ARMv8 cryptographic extensions, which must be available at runtime
3281 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003282 *
3283 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003284 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003285 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003286 * \note Minimum compiler versions for this feature are Clang 4.0,
3287 * armclang 6.6 or GCC 6.0.
3288 *
3289 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3290 * armclang <= 6.9
3291 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003292 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003293 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003294 * option.
3295 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003296 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3297 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003298 *
3299 * Requires: MBEDTLS_SHA256_C.
3300 *
3301 * Module: library/sha256.c
3302 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003303 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003304 * unconditionally.
3305 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003306//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003307
Dave Rodgmand85277c2023-10-13 09:22:54 +01003308/**
3309 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3310 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003311 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003312 * This name is now deprecated, but may still be used as an alternative form for
3313 * this option.
3314 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003315//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3316
3317/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003318 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003319 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003320 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003321 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003322 * Module: library/sha512.c
3323 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003324 * library/psa_crypto_hash.c
3325 * library/ssl_tls.c
3326 * library/ssl*_client.c
3327 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003328 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003329 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003330 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003331#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003332
3333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003335 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003336 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003337 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003338 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003339 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003340 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003341 * library/ssl_tls.c
3342 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003344 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003347
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003348/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003349 * \def MBEDTLS_SHA3_C
3350 *
3351 * Enable the SHA3 cryptographic hash algorithm.
3352 *
3353 * Module: library/sha3.c
3354 *
3355 * This module adds support for SHA3.
3356 */
3357#define MBEDTLS_SHA3_C
3358
3359/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003360 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3361 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003362 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3363 * with the ARMv8 cryptographic extensions if they are available at runtime.
3364 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003365 *
3366 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3367 * for a non-Aarch64 build it will be silently ignored.
3368 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003369 * \note Minimum compiler versions for this feature are Clang 7.0,
3370 * armclang 6.9 or GCC 8.0.
3371 *
3372 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3373 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003374 *
3375 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3376 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3377 *
3378 * Requires: MBEDTLS_SHA512_C.
3379 *
3380 * Module: library/sha512.c
3381 *
3382 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3383 * and use them if available.
3384 */
3385//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3386
3387/**
3388 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3389 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003390 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3391 * with the ARMv8 cryptographic extensions, which must be available at runtime
3392 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003393 *
3394 * \note This allows builds with a smaller code size than with
3395 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3396 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003397 * \note Minimum compiler versions for this feature are Clang 7.0,
3398 * armclang 6.9 or GCC 8.0.
3399 *
3400 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3401 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003402 *
3403 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3404 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3405 *
3406 * Requires: MBEDTLS_SHA512_C.
3407 *
3408 * Module: library/sha512.c
3409 *
3410 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3411 * unconditionally.
3412 */
3413//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3414
3415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003417 *
3418 * Enable simple SSL cache implementation.
3419 *
3420 * Module: library/ssl_cache.c
3421 * Caller:
3422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003426
3427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003429 *
3430 * Enable basic implementation of DTLS cookies for hello verification.
3431 *
3432 * Module: library/ssl_cookie.c
3433 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003436
3437/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003438 * \def MBEDTLS_SSL_TICKET_C
3439 *
3440 * Enable an implementation of TLS server-side callbacks for session tickets.
3441 *
3442 * Module: library/ssl_ticket.c
3443 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003444 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003445 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3446 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003447 */
3448#define MBEDTLS_SSL_TICKET_C
3449
3450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003451 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003452 *
3453 * Enable the SSL/TLS client code.
3454 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003455 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003456 * Caller:
3457 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003458 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003459 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003460 * This module is required for SSL/TLS client support.
3461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003463
Paul Bakker9a736322012-11-14 12:39:52 +00003464/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003466 *
3467 * Enable the SSL/TLS server code.
3468 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003469 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003470 * Caller:
3471 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003473 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003474 * This module is required for SSL/TLS server support.
3475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003477
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003479 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003480 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003481 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003482 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003483 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003484 * Caller: library/ssl*_client.c
3485 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003486 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3488 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003489 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003490 * This module is required for SSL/TLS.
3491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003492#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003493
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003496 *
3497 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003498 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003499 * contexts are not shared between threads. If you do intend to use contexts
3500 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003501 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003502 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003503 *
3504 * Module: library/threading.c
3505 *
3506 * This allows different threading implementations (self-implemented or
3507 * provided).
3508 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509 * You will have to enable either MBEDTLS_THREADING_ALT or
3510 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003511 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003512 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003515
3516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003518 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003519 * Enable the semi-portable timing interface.
3520 *
Simon Butcherd567a232016-03-09 20:19:21 +00003521 * \note The provided implementation only works on POSIX/Unix (including Linux,
3522 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003523 * module and provide your own implementations of the callbacks needed by
3524 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3525 * your own implementation of the whole module by setting
3526 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003527 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003528 * \note The timing module will include time.h on suitable platforms
3529 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3530 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3531 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003532 * \note See also our Knowledge Base article about porting to a new
3533 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003534 * 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 +00003535 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003536 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003539
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003542 *
3543 * Enable run-time version information.
3544 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003545 * Module: library/version.c
3546 *
3547 * This module provides run-time version information.
3548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003550
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003553 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003554 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003555 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003556 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003557 * Caller: library/x509_crl.c
3558 * library/x509_crt.c
3559 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003560 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003561 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003562 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3563 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003564 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3565 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003566 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003567 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003570
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003573 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003574 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003575 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003576 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003577 * Caller: library/ssl_tls.c
3578 * library/ssl*_client.c
3579 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003582 *
3583 * This module is required for X.509 certificate parsing.
3584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003586
3587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003589 *
3590 * Enable X.509 CRL parsing.
3591 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003592 * Module: library/x509_crl.c
3593 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003594 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003596 *
3597 * This module is required for X.509 CRL parsing.
3598 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003600
3601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003603 *
3604 * Enable X.509 Certificate Signing Request (CSR) parsing.
3605 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003606 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003607 * Caller: library/x509_crt_write.c
3608 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003610 *
3611 * This module is used for reading X.509 certificate request.
3612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003614
3615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003617 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003618 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003619 *
3620 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003621 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003622 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003623 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3624 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003625 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3626 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003627 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003628 * This module is the basis for creating X.509 certificates and CSRs.
3629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003631
3632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003634 *
3635 * Enable creating X.509 certificates.
3636 *
3637 * Module: library/x509_crt_write.c
3638 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003640 *
3641 * This module is required for X.509 certificate creation.
3642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003644
3645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003646 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003647 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003648 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003649 *
3650 * Module: library/x509_csr_write.c
3651 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003652 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003653 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003654 * This module is required for X.509 certificate request writing.
3655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003656#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003657
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003658/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003659
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003660/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003661 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003662 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003663 * This section contains Mbed TLS build settings that are not associated
3664 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003665 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003666 * \{
3667 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003668
Gilles Peskinea02c1242022-03-16 17:03:19 +01003669/**
3670 * \def MBEDTLS_CONFIG_FILE
3671 *
3672 * If defined, this is a header which will be included instead of
3673 * `"mbedtls/mbedtls_config.h"`.
3674 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003675 * Unlike other configuration options, this one must be defined on the
3676 * compiler command line: a definition in `mbedtls_config.h` would have
3677 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003678 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003679 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003680 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003681 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003682 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003683 * The value of this symbol is typically a path in double quotes, either
3684 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003685 */
3686//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3687
3688/**
3689 * \def MBEDTLS_USER_CONFIG_FILE
3690 *
3691 * If defined, this is a header which will be included after
3692 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003693 * This allows you to modify the default configuration, including the ability
3694 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003695 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003696 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003697 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003698 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003699 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003700 * The value of this symbol is typically a path in double quotes, either
3701 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003702 */
3703//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3704
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003705/**
3706 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3707 *
3708 * If defined, this is a header which will be included instead of
3709 * `"psa/crypto_config.h"`.
3710 * This header file specifies which cryptographic mechanisms are available
3711 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3712 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3713 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003714 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003715 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003716 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003717 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003718 * The value of this symbol is typically a path in double quotes, either
3719 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003720 */
3721//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3722
3723/**
3724 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3725 *
3726 * If defined, this is a header which will be included after
3727 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003728 * This allows you to modify the default configuration, including the ability
3729 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003730 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003731 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003732 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003733 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003734 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003735 * The value of this symbol is typically a path in double quotes, either
3736 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003737 */
3738//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3739
Gilles Peskineb1176f22023-02-22 22:07:28 +01003740/**
3741 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3742 *
3743 * If defined, this is a header which will be included instead of
3744 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3745 * as the one in Mbed TLS, but with definitions adapted to the platform on
3746 * which the library code will run.
3747 *
3748 * \note The required content of this header can vary from one version of
3749 * Mbed TLS to the next. Integrators who provide an alternative file
3750 * should review the changes in the original file whenever they
3751 * upgrade Mbed TLS.
3752 *
3753 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3754 * non-standard feature of the C language, so this feature is only available
3755 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3756 *
3757 * The value of this symbol is typically a path in double quotes, either
3758 * absolute or relative to a directory on the include search path.
3759 */
3760//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3761
3762/**
3763 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3764 *
3765 * If defined, this is a header which will be included instead of
3766 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3767 * as the one in Mbed TLS, but with definitions adapted to the environment
3768 * in which the library code will run. The typical use for this feature
3769 * is to provide alternative type definitions on the client side in
3770 * client-server integrations of PSA crypto, where operation structures
3771 * contain handles instead of cryptographic data.
3772 *
3773 * \note The required content of this header can vary from one version of
3774 * Mbed TLS to the next. Integrators who provide an alternative file
3775 * should review the changes in the original file whenever they
3776 * upgrade Mbed TLS.
3777 *
3778 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3779 * non-standard feature of the C language, so this feature is only available
3780 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3781 *
3782 * The value of this symbol is typically a path in double quotes, either
3783 * absolute or relative to a directory on the include search path.
3784 */
3785//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3786
Gilles Peskineba4162a2022-04-11 17:04:38 +02003787/** \} name SECTION: General configuration options */
3788
3789/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003790 * \name SECTION: Module configuration options
3791 *
3792 * This section allows for the setting of module specific sizes and
3793 * configuration options. The default values are already present in the
3794 * relevant header files and should suffice for the regular use cases.
3795 *
3796 * Our advice is to enable options and change their values here
3797 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003798 * \{
3799 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003800/* The Doxygen documentation here is used when a user comments out a
3801 * setting and runs doxygen themselves. On the other hand, when we typeset
3802 * the full documentation including disabled settings, the documentation
3803 * in specific modules' header files is used if present. When editing this
3804 * file, make sure that each option is documented in exactly one place,
3805 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3806 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003807
Paul Bakker088c5c52014-04-25 11:11:10 +02003808/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003809//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003810//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003811
Paul Bakker088c5c52014-04-25 11:11:10 +02003812/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003813//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3814//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3815//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3816//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3817//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003818
Paul Bakker088c5c52014-04-25 11:11:10 +02003819/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003820//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3821//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3822//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3823//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003824
Paul Bakker088c5c52014-04-25 11:11:10 +02003825/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003826//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003827//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003828
Paul Bakker088c5c52014-04-25 11:11:10 +02003829/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003830//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3831//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003832//#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 +01003833
Paul Bakker088c5c52014-04-25 11:11:10 +02003834/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003836
Paul Bakker088c5c52014-04-25 11:11:10 +02003837/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838//#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 -04003839
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003840/** \def MBEDTLS_PLATFORM_STD_CALLOC
3841 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003842 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003843 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003844 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003845 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003846 * 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 -04003847 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3848 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003849 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003850 */
3851//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003852
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003853/** \def MBEDTLS_PLATFORM_STD_FREE
3854 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003855 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003856 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003857 * 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 -04003858 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3859 * 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 -04003860 */
3861//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003862//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003863//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003864//#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 +02003865//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3866//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003867/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003868//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003869//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3870//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003871//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3872//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3873//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003874
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003875/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003876/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003877//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3878//#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 +02003879//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003880//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003881//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3882//#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 +02003883//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3884//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003885/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003886//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003887//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003888//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3889//#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 +08003890//#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 +08003891//#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 +02003892
Gilles Peskine3f106f72021-09-23 17:42:39 +02003893/** \def MBEDTLS_CHECK_RETURN
3894 *
3895 * This macro is used at the beginning of the declaration of a function
3896 * to indicate that its return value should be checked. It should
3897 * instruct the compiler to emit a warning or an error if the function
3898 * is called without checking its return value.
3899 *
3900 * There is a default implementation for popular compilers in platform_util.h.
3901 * You can override the default implementation by defining your own here.
3902 *
3903 * If the implementation here is empty, this will effectively disable the
3904 * checking of functions' return values.
3905 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003906//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003907
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003908/** \def MBEDTLS_IGNORE_RETURN
3909 *
3910 * This macro requires one argument, which should be a C function call.
3911 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3912 * warning is suppressed.
3913 */
3914//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3915
Gilles Peskineed038902020-11-13 21:33:21 +01003916/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003917/**
Gilles Peskineed038902020-11-13 21:33:21 +01003918 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3919 * PSA crypto subsystem.
3920 *
3921 * If this option is unset:
3922 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003923 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003924 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3925 * on unspecified heuristics.
3926 */
3927//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3928
Steven Cooreman863470a2021-02-15 14:03:19 +01003929/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003930 * Restrict the PSA library to supporting a maximum amount of simultaneously
3931 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3932 * volatile key, or a persistent key which is loaded temporarily by the
3933 * library as part of a crypto operation in flight.
3934 *
3935 * If this option is unset, the library will fall back to a default value of
3936 * 32 keys.
3937 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003938//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003939
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003940/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003941//#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 +00003942
Paul Bakker088c5c52014-04-25 11:11:10 +02003943/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003944//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3945//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003946
Paul Bakker088c5c52014-04-25 11:11:10 +02003947/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003948
Angus Grattond8213d02016-05-25 20:56:48 +10003949/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3950 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003951 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003952 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003953 * This determines the size of the incoming TLS I/O buffer in such a way
3954 * that it is capable of holding the specified amount of plaintext data,
3955 * regardless of the protection mechanism used.
3956 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003957 * \note When using a value less than the default of 16KB on the client, it is
3958 * recommended to use the Maximum Fragment Length (MFL) extension to
3959 * inform the server about this limitation. On the server, there
3960 * is no supported, standardized way of informing the client about
3961 * restriction on the maximum size of incoming messages, and unless
3962 * the limitation has been communicated by other means, it is recommended
3963 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3964 * while keeping the default value of 16KB for the incoming buffer.
3965 *
David Horstmann95d516f2021-05-04 18:36:56 +01003966 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003967 */
3968//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3969
Gilles Peskined3d02902020-03-04 21:35:27 +01003970/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3971 *
3972 * The maximum length of CIDs used for incoming DTLS messages.
3973 *
3974 */
3975//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3976
3977/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3978 *
3979 * The maximum length of CIDs used for outgoing DTLS messages.
3980 *
3981 */
3982//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3983
TRodziewicze8dd7092021-05-12 14:19:11 +02003984/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003985 *
3986 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003987 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003988 *
3989 * The padding will always be chosen so that the length of the
3990 * padded plaintext is a multiple of the value of this option.
3991 *
3992 * Note: A value of \c 1 means that no padding will be used
3993 * for outgoing records.
3994 *
3995 * Note: On systems lacking division instructions,
3996 * a power of two should be preferred.
3997 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003998//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003999
Angus Grattond8213d02016-05-25 20:56:48 +10004000/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4001 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004002 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004003 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004004 * This determines the size of the outgoing TLS I/O buffer in such a way
4005 * that it is capable of holding the specified amount of plaintext data,
4006 * regardless of the protection mechanism used.
4007 *
Angus Grattond8213d02016-05-25 20:56:48 +10004008 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4009 * the default inward 16384 byte buffer to conform to the TLS specification.
4010 *
4011 * The minimum required outward buffer size is determined by the handshake
4012 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4013 * The specific size requirement depends on the configured ciphers and any
4014 * certificate data which is sent during the handshake.
4015 *
David Horstmann95d516f2021-05-04 18:36:56 +01004016 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004017 */
4018//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4019
Hanno Beckere0b150f2018-08-21 15:51:03 +01004020/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4021 *
4022 * Maximum number of heap-allocated bytes for the purpose of
4023 * DTLS handshake message reassembly and future message buffering.
4024 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004025 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004026 * to account for a reassembled handshake message of maximum size,
4027 * together with its reassembly bitmap.
4028 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004029 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004030 * should be sufficient for all practical situations as it allows
4031 * to reassembly a large handshake message (such as a certificate)
4032 * while buffering multiple smaller handshake messages.
4033 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004034 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004035//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004036
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004037//#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 +02004038//#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 +02004039
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004040/**
4041 * Complete list of ciphersuites to use, in order of preference.
4042 *
4043 * \warning No dependency checking is done on that field! This option can only
4044 * be used to restrict the set of available ciphersuites. It is your
4045 * responsibility to make sure the needed modules are active.
4046 *
4047 * Use this to save a few hundred bytes of ROM (default ordering of all
4048 * available ciphersuites) and a few to a few hundred bytes of RAM.
4049 *
4050 * The value below is only an example, not the default.
4051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004052//#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 +02004053
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004054/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004055 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4056 *
4057 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004058 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004059 *
4060 * It must be positive and smaller than UINT32_MAX.
4061 *
4062 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4063 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004064 */
4065//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4066
4067/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004068 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4069 *
Jerry Yucf913512023-11-14 11:06:52 +08004070 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004071 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004072 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004073 * - The client ticket age is the time difference between the time when the
4074 * client proposes to the server to use the ticket and the time the client
4075 * received the ticket from the server.
4076 * - The server ticket age is the time difference between the time when the
4077 * server receives a proposition from the client to use the ticket and the
4078 * time when the ticket was created by the server.
4079 *
Jerry Yucf913512023-11-14 11:06:52 +08004080 * The ages might be different due to the client and server clocks not running
4081 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4082 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4083 * 6s, thus in the worst case clients and servers must sync up their system time
4084 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004085 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004086 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004087 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004088//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004089
4090/**
4091 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4092 *
4093 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4094 *
4095 * This must be less than 256.
4096 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004097//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004098
4099/**
4100 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4101 *
4102 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4103 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4104 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4105 *
4106 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004107//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004108
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004109/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004110//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004111//#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 +01004112
Gilles Peskine611179c2022-04-13 23:04:48 +02004113/** \} name SECTION: Module configuration options */