blob: a675f317faee7b079116ace8bdaea734308dcf3a [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
Ron Eldor314adb62017-10-10 18:28:25 +0300353//#define MBEDTLS_ECDSA_VERIFY_ALT
354//#define MBEDTLS_ECDSA_SIGN_ALT
355//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200356
357/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200358 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200359 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200360 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200361 * hardware entropy collector.
362 *
363 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000364 * prototype as declared in library/entropy_poll.h, and accept NULL as first
365 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200366 *
367 * Uncomment to use your own hardware entropy collector.
368 */
369//#define MBEDTLS_ENTROPY_HARDWARE_ALT
370
371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000373 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100374 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000375 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100376 * Uncomment this macro to use precomputed AES tables stored in ROM.
377 * Comment this macro to generate AES tables in RAM at runtime.
378 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100379 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
380 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100381 * initialization time before the first AES operation can be performed.
382 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
383 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
384 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100385 *
386 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000389
390/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200392 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100393 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200394 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100395 * Uncommenting this macro omits 75% of the AES tables from
396 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
397 * by computing their values on the fly during operations
398 * (the tables are entry-wise rotations of one another).
399 *
400 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100401 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100402 * runtime. Specifically, one has to compare 4 accesses within
403 * different tables to 4 accesses with additional arithmetic
404 * operations within the same table. The performance gain/loss
405 * depends on the system and memory details.
406 *
407 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200408 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100409//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200410
411/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800412 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
413 *
414 * Use only 128-bit keys in AES operations to save ROM.
415 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800416 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 * or 256-bit keys.
418 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800419 * Uncommenting this macro reduces the size of AES code by ~300 bytes
420 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800422 * Module: library/aes.c
423 *
424 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800425 */
426//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
427
Gilles Peskinea8861e02023-09-05 20:20:51 +0200428/*
429 * Disable plain C implementation for AES.
430 *
431 * When the plain C implementation is enabled, and an implementation using a
432 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
433 * detection will be used to select between them.
434 *
435 * If only one implementation is present, runtime detection will not be used.
436 * This configuration will crash at runtime if running on a CPU without the
437 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
438 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
439 */
440//#define MBEDTLS_AES_USE_HARDWARE_ONLY
441
Arto Kinnunen732ca322023-04-14 14:26:10 +0800442/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200444 *
445 * Use less ROM for the Camellia implementation (saves about 768 bytes).
446 *
447 * Uncomment this macro to use less memory for Camellia.
448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200449//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200450
451/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200452 * \def MBEDTLS_CHECK_RETURN_WARNING
453 *
454 * If this macro is defined, emit a compile-time warning if application code
455 * calls a function without checking its return value, but the return value
456 * should generally be checked in portable applications.
457 *
458 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
459 * implemented. Otherwise this option has no effect.
460 *
461 * Uncomment to get warnings on using fallible functions without checking
462 * their return value.
463 *
464 * \note This feature is a work in progress.
465 * Warnings will be added to more functions in the future.
466 *
467 * \note A few functions are considered critical, and ignoring the return
468 * value of these functions will trigger a warning even if this
469 * macro is not defined. To completely disable return value check
470 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
471 */
472//#define MBEDTLS_CHECK_RETURN_WARNING
473
474/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476 *
477 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200480
481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483 *
484 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200486#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000487
488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490 *
491 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000494
495/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100496 * \def MBEDTLS_CIPHER_MODE_OFB
497 *
498 * Enable Output Feedback mode (OFB) for symmetric ciphers.
499 */
500#define MBEDTLS_CIPHER_MODE_OFB
501
502/**
503 * \def MBEDTLS_CIPHER_MODE_XTS
504 *
505 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
506 */
507#define MBEDTLS_CIPHER_MODE_XTS
508
509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000511 *
512 * Enable NULL cipher.
513 * Warning: Only do so when you know what you are doing. This allows for
514 * encryption or channels without any security!
515 *
Ronald Croncee42702021-04-26 11:34:44 +0200516 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200517 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
518 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
519 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
520 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
521 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
522 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
523 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
524 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
525 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
526 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
527 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
528 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
529 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
530 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
531 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
532 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
533 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
534 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
535 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000536 *
537 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200539//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000540
541/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100542 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200543 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100544 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
545 * specific padding modes in the cipher layer with cipher modes that support
546 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200547 *
548 * If you disable all padding modes, only full blocks can be used with CBC.
549 *
550 * Enable padding modes in the cipher layer.
551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552#define MBEDTLS_CIPHER_PADDING_PKCS7
553#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
554#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
555#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200556
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200557/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
558 *
559 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800560 * Without this, CTR_DRBG uses a 256-bit key
561 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200562 */
563//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
564
Paul Bakker48e93c82013-08-14 12:21:18 +0200565/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200566 * Enable the verified implementations of ECDH primitives from Project Everest
567 * (currently only Curve25519). This feature changes the layout of ECDH
568 * contexts and therefore is a compatibility break for applications that access
569 * fields of a mbedtls_ecdh_context structure directly. See also
570 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000571 *
572 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
573 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200574 */
575//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
576
577/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100578 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200579 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100580 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
581 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200582 *
583 * Comment macros to disable the curve and functions for it
584 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200585/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
587#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
588#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
589#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
590#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
591#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
592#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
593#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
594#define MBEDTLS_ECP_DP_BP256R1_ENABLED
595#define MBEDTLS_ECP_DP_BP384R1_ENABLED
596#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200597/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200598#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000599#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200600
601/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200603 *
604 * Enable specific 'modulo p' routines for each NIST prime.
605 * Depending on the prime and architecture, makes operations 4 to 8 times
606 * faster on the corresponding curve.
607 *
608 * Comment this macro to disable NIST curves optimisation.
609 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200611
612/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200613 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100614 *
615 * Enable "non-blocking" ECC operations that can return early and be resumed.
616 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200617 * This allows various functions to pause by returning
618 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
619 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
620 * order to further progress and eventually complete their operation. This is
621 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
622 * number of ECC operations a function may perform before pausing; see
623 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100624 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200625 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200626 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100627 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100628 * This option:
629 * - Adds xxx_restartable() variants of existing operations in the
630 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100631 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
632 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100633 * - ECDSA: signature generation & verification;
634 * - PK: signature generation & verification;
635 * - X509: certificate chain verification.
636 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
637 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
638 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
639 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000640 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100641 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100642 * - verification of the server's key exchange signature;
643 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100644 * - generation of the client's signature if client authentication is used,
645 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100646 *
647 * \note In the cases above, the usual SSL/TLS functions, such as
648 * mbedtls_ssl_handshake(), can now return
649 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200650 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100651 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
652 * restartable operations in PK, X.509 and TLS (see above) are not
653 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100654 * PSA, and are not restartable. These are temporary limitations that
655 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200656 *
Ron Eldor19779c42018-11-05 16:58:13 +0200657 * \note This option only works with the default software implementation of
658 * elliptic curve functionality. It is incompatible with
Thomas Daubney9da17692024-06-06 14:04:49 +0100659 * MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100660 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100661 * Requires: MBEDTLS_ECP_C
662 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100663 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100664 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200665//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100666
667/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200668 * Uncomment to enable using new bignum code in the ECC modules.
669 *
670 * \warning This is currently experimental, incomplete and therefore should not
671 * be used in production.
672 */
673//#define MBEDTLS_ECP_WITH_MPI_UINT
674
675/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100677 *
678 * Enable deterministic ECDSA (RFC 6979).
679 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
680 * may result in a compromise of the long-term signing key. This is avoided by
681 * the deterministic variant.
682 *
John Durkop36a82e52020-10-26 09:39:05 -0700683 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100684 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100685 * Comment this macro to disable deterministic ECDSA.
686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100688
689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200690 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200691 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200692 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200693 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200694 * This enables the following ciphersuites (if other requisites are
695 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
697 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
698 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
699 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
700 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
701 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
702 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
703 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
704 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
705 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200708
709/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200710 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200711 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200712 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200713 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200714 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200715 *
716 * This enables the following ciphersuites (if other requisites are
717 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
719 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
720 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
721 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
722 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
723 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
724 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
725 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
726 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
727 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100728 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100729 * \warning Using DHE constitutes a security risk as it
730 * is not possible to validate custom DH parameters.
731 * If possible, it is recommended users should consider
732 * preferring other methods of key exchange.
733 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100734 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200737
738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200739 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200740 *
741 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
742 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200743 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200744 *
745 * This enables the following ciphersuites (if other requisites are
746 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
748 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
749 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
750 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
751 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
752 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200755
756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200758 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200759 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200760 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200761 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
762 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
764 * This enables the following ciphersuites (if other requisites are
765 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
767 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
768 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
769 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
770 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
771 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
772 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
773 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
774 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
775 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200777#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200778
779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200781 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200782 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
785 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200786 *
787 * This enables the following ciphersuites (if other requisites are
788 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
790 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
791 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
792 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
793 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
794 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
795 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
796 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
797 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
798 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
799 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
800 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200803
804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200807 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
810 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
812 * This enables the following ciphersuites (if other requisites are
813 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
815 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
816 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
817 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
818 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
819 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
820 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
821 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
822 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
823 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
824 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
825 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100826 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100827 * \warning Using DHE constitutes a security risk as it
828 * is not possible to validate custom DH parameters.
829 * If possible, it is recommended users should consider
830 * preferring other methods of key exchange.
831 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100832 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835
836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200839 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200841 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
842 * MBEDTLS_RSA_C
843 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200845 *
846 * This enables the following ciphersuites (if other requisites are
847 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
849 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
850 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
851 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
852 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
853 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
854 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
855 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
856 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
857 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860
861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200864 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200865 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200866 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
867 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
868 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200869 *
870 * This enables the following ciphersuites (if other requisites are
871 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
873 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
874 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
875 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
876 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
877 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
878 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
879 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
880 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
881 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200884
885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100887 *
888 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
889 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200890 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
891 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
892 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100893 *
894 * This enables the following ciphersuites (if other requisites are
895 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
897 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
898 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
899 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
900 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
901 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
902 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
903 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
904 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
905 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100908
909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100911 *
912 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
913 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200914 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
915 * MBEDTLS_RSA_C
916 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100917 *
918 * This enables the following ciphersuites (if other requisites are
919 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
921 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
922 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
925 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
926 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
927 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
929 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100932
933/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200934 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
935 *
936 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
937 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200938 * \warning This is currently experimental. EC J-PAKE support is based on the
939 * Thread v1.0.0 specification; incompatible changes to the specification
940 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200941 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200942 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100943 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200944 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
945 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100946 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800947 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100948 * MBEDTLS_USE_PSA_CRYPTO is disabled).
949 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200950 * This enables the following ciphersuites (if other requisites are
951 * enabled as well):
952 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
953 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200954//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200955
956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100958 *
959 * Enhance support for reading EC keys using variants of SEC1 not allowed by
960 * RFC 5915 and RFC 5480.
961 *
962 * Currently this means parsing the SpecifiedECDomain choice of EC
963 * parameters (only known groups are supported, not arbitrary domains, to
964 * avoid validation issues).
965 *
966 * Disable if you only need to support RFC 5915 + 5480 key formats.
967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100969
970/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200971 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
972 *
973 * Enable the support for parsing public keys of type Short Weierstrass
974 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200975 * compressed point format. This parsing is done through ECP module's functions.
976 *
977 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
978 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
979 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200980 */
981#define MBEDTLS_PK_PARSE_EC_COMPRESSED
982
983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100985 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200986 * Enable a dummy error function to make use of mbedtls_strerror() in
987 * third party libraries easier when MBEDTLS_ERROR_C is disabled
988 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200989 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
991 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100992 *
993 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100995 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200996#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100997
998/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001000 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001001 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001006
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001008 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001009 *
1010 * Enable functions that use the filesystem.
1011 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001012#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001013
1014/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001016 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001017 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001018 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001019 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001020 * application.
1021 *
1022 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001025
1026/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001028 *
1029 * Do not use built-in platform entropy functions.
1030 * This is useful if your platform does not support
1031 * standards like the /dev/urandom or Windows CryptoAPI.
1032 *
1033 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001036
1037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001039 *
1040 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1041 * default SHA-512 based one (if both are available).
1042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001044 *
1045 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1046 * if you have performance concerns.
1047 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * This option is only useful if both MBEDTLS_SHA256_C and
1049 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001050 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001052
1053/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001054 * \def MBEDTLS_ENTROPY_NV_SEED
1055 *
1056 * Enable the non-volatile (NV) seed file-based entropy source.
1057 * (Also enables the NV seed read/write functions in the platform layer)
1058 *
1059 * This is crucial (if not required) on systems that do not have a
1060 * cryptographic entropy source (in hardware or kernel) available.
1061 *
1062 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1063 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001064 * \note The read/write functions that are used by the entropy source are
1065 * determined in the platform layer, and can be modified at runtime and/or
1066 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1067 *
1068 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001069 * with regular fopen(), please make sure you make a seedfile with the
1070 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1071 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001072 * and written to or you will get an entropy source error! The default
1073 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1074 * bytes from the file.
1075 *
1076 * \note The entropy collector will write to the seed file before entropy is
1077 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001078 */
1079//#define MBEDTLS_ENTROPY_NV_SEED
1080
Ronald Cron71016a92020-08-28 19:01:50 +02001081/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001082 *
Ronald Cron71016a92020-08-28 19:01:50 +02001083 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001084 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001085 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1086 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001087 *
1088 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001089 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001090 */
Ronald Cron71016a92020-08-28 19:01:50 +02001091//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001092
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001095 *
1096 * Enable debugging of buffer allocator memory issues. Automatically prints
1097 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1098 * function for 'debug output' of allocated memory.
1099 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001101 *
1102 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001105
1106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001107 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001108 *
1109 * Include backtrace information with each allocated block.
1110 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001112 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001113 *
1114 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001117
1118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001120 *
1121 * Support external private RSA keys (eg from a HSM) in the PK layer.
1122 *
1123 * Comment this macro to disable support for external private RSA keys.
1124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001126
1127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001128 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001129 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001130 * Enable support for PKCS#1 v1.5 encoding.
1131 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001132 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001133 *
Paul Bakker48377d92013-08-30 12:06:24 +02001134 * This enables support for PKCS#1 v1.5 operations.
1135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001137
1138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001140 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001141 * Enable support for PKCS#1 v2.1 encoding.
1142 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001143 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001144 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001145 * \warning If using a hash that is only provided by PSA drivers, you must
1146 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001147 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001148 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001151
Steven Cooreman6801f082021-02-19 17:21:22 +01001152/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1153 *
1154 * Enable support for platform built-in keys. If you enable this feature,
1155 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1156 * See the documentation of that function for more information.
1157 *
1158 * Built-in keys are typically derived from a hardware unique key or
1159 * stored in a secure element.
1160 *
1161 * Requires: MBEDTLS_PSA_CRYPTO_C.
1162 *
1163 * \warning This interface is experimental and may change or be removed
1164 * without notice.
1165 */
1166//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1167
Ronald Cron3768ac12021-01-26 16:58:00 +01001168/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1169 *
1170 * Enable support for PSA crypto client.
1171 *
1172 * \note This option allows to include the code necessary for a PSA
1173 * crypto client when the PSA crypto implementation is not included in
1174 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1175 * code to set and get PSA key attributes.
1176 * The development of PSA drivers partially relying on the library to
1177 * fulfill the hardware gaps is another possible usage of this option.
1178 *
1179 * \warning This interface is experimental and may change or be removed
1180 * without notice.
1181 */
1182//#define MBEDTLS_PSA_CRYPTO_CLIENT
1183
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001184/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1185 *
1186 * Make the PSA Crypto module use an external random generator provided
1187 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1188 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001189 * \note This random generator must deliver random numbers with cryptographic
1190 * quality and high performance. It must supply unpredictable numbers
1191 * with a uniform distribution. The implementation of this function
1192 * is responsible for ensuring that the random generator is seeded
1193 * with sufficient entropy. If you have a hardware TRNG which is slow
1194 * or delivers non-uniform output, declare it as an entropy source
1195 * with mbedtls_entropy_add_source() instead of enabling this option.
1196 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001197 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001198 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1199 * and define a function called mbedtls_psa_external_get_random()
1200 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001201 * ```
1202 * psa_status_t mbedtls_psa_external_get_random(
1203 * mbedtls_psa_external_random_context_t *context,
1204 * uint8_t *output, size_t output_size, size_t *output_length);
1205 * );
1206 * ```
1207 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001208 * The function must fill the \c output buffer with \c output_size bytes
1209 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001210 *
1211 * Requires: MBEDTLS_PSA_CRYPTO_C
1212 *
1213 * \warning If you enable this option, code that uses the PSA cryptography
1214 * interface will not use any of the entropy sources set up for
1215 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1216 * enables.
1217 *
1218 * \note This option is experimental and may be removed without notice.
1219 */
1220//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1221
Paul Bakker9dcc3222011-03-08 14:16:06 +00001222/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001223 * \def MBEDTLS_PSA_CRYPTO_SPM
1224 *
1225 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1226 * Partition Manager) integration which separates the code into two parts: a
1227 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1228 * Environment).
1229 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001230 * If you enable this option, your build environment must include a header
1231 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1232 * header files, or in another directory on the compiler's include search
1233 * path). Alternatively, your platform may customize the header
1234 * `psa/crypto_platform.h`, in which case it can skip or replace the
1235 * inclusion of `"crypto_spe.h"`.
1236 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001237 * Module: library/psa_crypto.c
1238 * Requires: MBEDTLS_PSA_CRYPTO_C
1239 *
1240 */
1241//#define MBEDTLS_PSA_CRYPTO_SPM
1242
1243/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001244 * Uncomment to enable p256-m. This is an alternative implementation of
1245 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1246 * Compared to the default implementation:
1247 *
1248 * - p256-m has a much smaller code size and RAM footprint.
1249 * - p256-m is only available via the PSA API. This includes the pk module
1250 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1251 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1252 * over the core arithmetic, or deterministic derivation of keys.
1253 *
1254 * We recommend enabling this option if your application uses the PSA API
1255 * and the only elliptic curve support it needs is ECDH and ECDSA over
1256 * SECP256R1.
1257 *
1258 * If you enable this option, you do not need to enable any ECC-related
1259 * MBEDTLS_xxx option. You do need to separately request support for the
1260 * cryptographic mechanisms through the PSA API:
1261 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1262 * configuration;
1263 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1264 * - #PSA_WANT_ECC_SECP_R1_256;
1265 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1266 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1267 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1268 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1269 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001270 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001271 * \note To benefit from the smaller code size of p256-m, make sure that you
1272 * do not enable any ECC-related option not supported by p256-m: this
1273 * would cause the built-in ECC implementation to be built as well, in
1274 * order to provide the required option.
1275 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001276 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1277 * SECP256R1 are disabled as they are not supported by this driver.
1278 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1279 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001280 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001281 */
1282//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1283
1284/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001285 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001286 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001287 * Enable support for entropy injection at first boot. This feature is
1288 * required on systems that do not have a built-in entropy source (TRNG).
1289 * This feature is currently not supported on systems that have a built-in
1290 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001291 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001292 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001293 *
1294 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001295//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001296
1297/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001298 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001299 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001300 * Assume all buffers passed to PSA functions are owned exclusively by the
1301 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001302 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001303 * This option may be enabled if all buffers passed to any PSA function reside
1304 * in memory that is accessible only to the PSA function during its execution.
1305 *
1306 * This option MUST be disabled whenever buffer arguments are in memory shared
1307 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001308 * across a trust boundary.
1309 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001310 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001311 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001312 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001313 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001314 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001315//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001316
1317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001319 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001320 * Do not use the Chinese Remainder Theorem
1321 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001322 *
1323 * Uncomment this macro to disable the use of CRT in RSA.
1324 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001327
1328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001330 *
1331 * Enable the checkup functions (*_self_test).
1332 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001334
1335/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001336 * \def MBEDTLS_SHA256_SMALLER
1337 *
1338 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1339 * lower performance.
1340 *
Adam Wolf039080f2019-09-10 09:53:08 -05001341 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001342 * performance and size. This version optimizes more aggressively for size at
1343 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1344 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1345 * 30%.
1346 *
1347 * Uncomment to enable the smaller implementation of SHA256.
1348 */
1349//#define MBEDTLS_SHA256_SMALLER
1350
1351/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001352 * \def MBEDTLS_SHA512_SMALLER
1353 *
1354 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1355 * lower performance.
1356 *
1357 * Uncomment to enable the smaller implementation of SHA512.
1358 */
1359//#define MBEDTLS_SHA512_SMALLER
1360
1361/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001363 *
1364 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001365 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001366 * with other servers, only debugging of failures is harder.
1367 *
1368 * The advantage of not sending alert messages, is that no information is given
1369 * about reasons for failures thus preventing adversaries of gaining intel.
1370 *
1371 * Enable sending of all alert messages
1372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001374
1375/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001376 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1377 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001378 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001380 * in the underlying transport. The CID functionality is described
1381 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001382 *
1383 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001384 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1385 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1386 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001387 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001388 * The maximum lengths of outgoing and incoming CIDs can be configured
1389 * through the options
1390 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1391 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1392 *
1393 * Requires: MBEDTLS_SSL_PROTO_DTLS
1394 *
1395 * Uncomment to enable the Connection ID extension.
1396 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001397#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1398
1399
1400/**
1401 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1402 *
1403 * Defines whether RFC 9146 (default) or the legacy version
1404 * (version draft-ietf-tls-dtls-connection-id-05,
1405 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1406 * is used.
1407 *
1408 * Set the value to 0 for the standard version, and
1409 * 1 for the legacy draft version.
1410 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001411 * \deprecated Support for the legacy version of the DTLS
1412 * Connection ID feature is deprecated. Please
1413 * switch to the standardized version defined
1414 * in RFC 9146 enabled by utilizing
1415 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1416 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1417 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001418 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1419 */
1420#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001421
1422/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001423 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1424 *
1425 * Enable asynchronous external private key operations in SSL. This allows
1426 * you to configure an SSL connection to call an external cryptographic
1427 * module to perform private key operations instead of performing the
1428 * operation inside the library.
1429 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001430 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001431 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001432//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001433
1434/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001435 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1436 *
1437 * Enable serialization of the TLS context structures, through use of the
1438 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1439 *
1440 * This pair of functions allows one side of a connection to serialize the
1441 * context associated with the connection, then free or re-use that context
1442 * while the serialized state is persisted elsewhere, and finally deserialize
1443 * that state to a live context for resuming read/write operations on the
1444 * connection. From a protocol perspective, the state of the connection is
1445 * unaffected, in particular this is entirely transparent to the peer.
1446 *
1447 * Note: this is distinct from TLS session resumption, which is part of the
1448 * protocol and fully visible by the peer. TLS session resumption enables
1449 * establishing new connections associated to a saved session with shorter,
1450 * lighter handshakes, while context serialization is a local optimization in
1451 * handling a single, potentially long-lived connection.
1452 *
1453 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1454 * saved after the handshake to allow for more efficient serialization, so if
1455 * you don't need this feature you'll save RAM by disabling it.
1456 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001457 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1458 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001459 * Comment to disable the context serialization APIs.
1460 */
1461#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1462
1463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001465 *
1466 * Enable the debug messages in SSL module for all issues.
1467 * Debug messages have been disabled in some places to prevent timing
1468 * attacks due to (unbalanced) debugging function calls.
1469 *
1470 * If you need all error reporting you should enable this during debugging,
1471 * but remove this for production servers that should log as well.
1472 *
1473 * Uncomment this macro to report all debug messages on errors introducing
1474 * a timing side-channel.
1475 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001480 *
1481 * Enable support for Encrypt-then-MAC, RFC 7366.
1482 *
1483 * This allows peers that both support it to use a more robust protection for
1484 * ciphersuites using CBC, providing deep resistance against timing attacks
1485 * on the padding or underlying cipher.
1486 *
1487 * This only affects CBC ciphersuites, and is useless if none is defined.
1488 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001489 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001490 *
1491 * Comment this macro to disable support for Encrypt-then-MAC
1492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001496 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001497 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1498 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001499 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001500 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001501 * attacks, but it is recommended to always use it (even if you disable
1502 * renegotiation), since it actually fixes a more fundamental issue in the
1503 * original SSL/TLS design, and has implications beyond Triple Handshake.
1504 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001505 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001506 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001507 * Comment this macro to disable support for Extended Master Secret.
1508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001510
Paul Bakkerd66f0702013-01-31 16:57:45 +01001511/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001512 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1513 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001514 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001515 * giving access to the peer's certificate after completion of the handshake.
1516 *
1517 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1518 * recommended to disable this option for reduced RAM usage.
1519 *
1520 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1521 * defined, but always returns \c NULL.
1522 *
1523 * \note This option has no influence on the protection against the
1524 * triple handshake attack. Even if it is disabled, Mbed TLS will
1525 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001526 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001527 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001528 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001529 *
1530 * Comment this macro to disable storing the peer's certificate
1531 * after the handshake.
1532 */
1533#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1534
1535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001537 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001538 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001539 *
1540 * The two main uses of renegotiation are (1) refresh keys on long-lived
1541 * connections and (2) client authentication after the initial handshake.
1542 * If you don't need renegotiation, it's probably better to disable it, since
1543 * it has been associated with security issues in the past and is easy to
1544 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001545 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001546 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1547 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001548 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001549 *
1550 * \note Even if this option is disabled, both client and server are aware
1551 * of the Renegotiation Indication Extension (RFC 5746) used to
1552 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1553 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1554 * configuration of this extension).
1555 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558
1559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001561 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001562 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001563 *
1564 * Comment this macro to disable support for the max_fragment_length extension
1565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001567
1568/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001569 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1570 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001571 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001572 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001573 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1574 *
1575 * Uncomment this macro to enable support for the record_size_limit extension
1576 */
1577//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1578
1579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001581 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001582 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001583 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001584 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001585 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1586 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001587 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001588 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001589 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001590 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1591 * are only provided by PSA drivers, you must call psa_crypto_init() before
1592 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001593 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001594 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001597
1598/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001599 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001600 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001601 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001602 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001603 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001604 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001606 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001607 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001608 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001609 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1610 * directly performed by TLS 1.3 code. As a consequence, you must
1611 * call psa_crypto_init() before the first TLS 1.3 handshake.
1612 *
1613 * \note Cryptographic operations performed indirectly via another module
1614 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1615 * running handshake hash) only use PSA crypto if
1616 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001617 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001618 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001619 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001620#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001621
1622/**
Ronald Cronab65c522021-11-24 10:47:20 +01001623 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1624 *
1625 * Enable TLS 1.3 middlebox compatibility mode.
1626 *
1627 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1628 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1629 * expecting TLS 1.2 traffic.
1630 *
1631 * Turning on the compatibility mode comes at the cost of a few added bytes
1632 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1633 * that don't use it. Therefore, unless transmission bandwidth is critical and
1634 * you know that middlebox compatibility issues won't occur, it is therefore
1635 * recommended to set this option.
1636 *
1637 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001638 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1639 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001640 *
1641 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001642#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001643
1644/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001645 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1646 *
1647 * Enable TLS 1.3 PSK key exchange mode.
1648 *
1649 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1650 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1651 * effect on the build.
1652 *
1653 */
1654#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1655
1656/**
1657 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1658 *
1659 * Enable TLS 1.3 ephemeral key exchange mode.
1660 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001661 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001662 * MBEDTLS_X509_CRT_PARSE_C
1663 * and at least one of:
1664 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1665 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001666 *
1667 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1668 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1669 * effect on the build.
1670 *
1671 */
1672#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1673
1674/**
1675 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1676 *
1677 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1678 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001679 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001680 *
1681 * Comment to disable support for the PSK ephemeral key exchange mode in
1682 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1683 * have any effect on the build.
1684 *
1685 */
1686#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1687
1688/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 * \def MBEDTLS_SSL_EARLY_DATA
1690 *
1691 * Enable support for RFC 8446 TLS 1.3 early data.
1692 *
1693 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1694 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1695 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1696 *
1697 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1698 * is not enabled, this option does not have any effect on the build.
1699 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001700 * \note The maximum amount of early data can be set with
1701 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1702 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001704//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001705
1706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001708 *
1709 * Enable support for DTLS (all available versions).
1710 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001711 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001712 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001713 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001714 *
1715 * Comment this macro to disable support for DTLS
1716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001718
1719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001721 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001722 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001723 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001724 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001727
1728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001730 *
1731 * Enable support for the anti-replay mechanism in DTLS.
1732 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733 * Requires: MBEDTLS_SSL_TLS_C
1734 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001735 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001736 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001737 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001738 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001739 * Comment this to disable anti-replay in DTLS.
1740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001742
1743/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001745 *
1746 * Enable support for HelloVerifyRequest on DTLS servers.
1747 *
1748 * This feature is highly recommended to prevent DTLS servers being used as
1749 * amplifiers in DoS attacks against other hosts. It should always be enabled
1750 * unless you know for sure amplification cannot be a problem in the
1751 * environment in which your server operates.
1752 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001753 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001754 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001755 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001756 *
1757 * Comment this to disable support for HelloVerifyRequest.
1758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001760
1761/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001762 * \def MBEDTLS_SSL_DTLS_SRTP
1763 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001764 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001765 * through the use_srtp extension.
1766 *
1767 * \note This feature provides the minimum functionality required
1768 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1769 * the associated SRTP packet protection key material.
1770 * In particular, the SRTP packet protection itself, as well as the
1771 * demultiplexing of RTP and DTLS packets at the datagram layer
1772 * (see Section 5 of RFC 5764), are not handled by this feature.
1773 * Instead, after successful completion of a handshake negotiating
1774 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001775 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001776 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1777 * (this is implemented in the SSL example programs).
1778 * The resulting key should then be passed to an SRTP stack.
1779 *
1780 * Setting this option enables the runtime API
1781 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1782 * through which the supported DTLS-SRTP protection
1783 * profiles can be configured. You must call this API at
1784 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001785 *
1786 * Requires: MBEDTLS_SSL_PROTO_DTLS
1787 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001788 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001789 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001790//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001791
1792/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001793 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1794 *
1795 * Enable server-side support for clients that reconnect from the same port.
1796 *
1797 * Some clients unexpectedly close the connection and try to reconnect using the
1798 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001799 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001800 * flag enables that support.
1801 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001802 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001803 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001804 * Comment this to disable support for clients reusing the source port.
1805 */
1806#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1807
1808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001810 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001811 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001812 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001813 * session store remains the responsibility of the application, though).
1814 * Server-side, you also need to provide callbacks for writing and parsing
1815 * tickets, including authenticated encryption and key management. Example
1816 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001817 *
1818 * Comment this macro to disable support for SSL session tickets
1819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001820#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001821
1822/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001824 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001825 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001826 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001828 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001829 * Comment this macro to disable support for server name indication in SSL
1830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001832
1833/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001834 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1835 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001836 * When this option is enabled, the SSL buffer will be resized automatically
1837 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001838 *
1839 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001840 */
1841//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1842
1843/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001844 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1845 *
1846 * Enable testing of the constant-flow nature of some sensitive functions with
1847 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001848 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001849 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001850 * This setting requires compiling with clang -fsanitize=memory. The test
1851 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001852 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001853 * \warning This macro is only used for extended testing; it is not considered
1854 * part of the library's API, so it may change or disappear at any time.
1855 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001856 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001857 */
1858//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1859
1860/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001861 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1862 *
1863 * Enable testing of the constant-flow nature of some sensitive functions with
1864 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001865 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001866 *
1867 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001868 * testing if the tests suites are run with valgrind's memcheck. This can be
1869 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1870 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001871 *
1872 * \warning This macro is only used for extended testing; it is not considered
1873 * part of the library's API, so it may change or disappear at any time.
1874 *
1875 * Uncomment to enable testing of the constant-flow nature of selected code.
1876 */
1877//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1878
1879/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001880 * \def MBEDTLS_TEST_HOOKS
1881 *
1882 * Enable features for invasive testing such as introspection functions and
1883 * hooks for fault injection. This enables additional unit tests.
1884 *
1885 * Merely enabling this feature should not change the behavior of the product.
1886 * It only adds new code, and new branching points where the default behavior
1887 * is the same as when this feature is disabled.
1888 * However, this feature increases the attack surface: there is an added
1889 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1890 * Therefore this feature must never be enabled in production.
1891 *
1892 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1893 * information.
1894 *
1895 * Uncomment to enable invasive tests.
1896 */
1897//#define MBEDTLS_TEST_HOOKS
1898
1899/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001901 *
1902 * Provide your own alternate threading implementation.
1903 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001904 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001905 *
1906 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001907 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001909
1910/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001912 *
1913 * Enable the pthread wrapper layer for the threading layer.
1914 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001916 *
1917 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001918 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001919//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001920
1921/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001922 * \def MBEDTLS_USE_PSA_CRYPTO
1923 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001924 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1925 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001926 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001927 * \note Development of this option is currently in progress, and parts of Mbed
1928 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001929 * will still continue to work as usual, so enabling this option should not
1930 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001931 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001932 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001933 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1934 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001935 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001936 * \note An important and desirable effect of this option is that it allows
1937 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1938 * 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 +02001939 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001940 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1941 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001942 *
1943 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001944 *
1945 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001946 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001947 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001949//#define MBEDTLS_USE_PSA_CRYPTO
1950
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001952 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1953 *
John Durkop185764f2020-10-12 21:32:12 -07001954 * This setting allows support for cryptographic mechanisms through the PSA
1955 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001956 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001957 * When this option is disabled, the PSA API exposes the cryptographic
1958 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1959 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001960 *
1961 * When this option is enabled, the PSA API exposes the cryptographic
1962 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1963 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1964 * automatically enabled if required (i.e. if no PSA driver provides the
1965 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1966 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001967 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001968 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001969 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001970 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001971 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1972 * symbols is not completely finalized yet, and the configuration
1973 * tooling is not ideally adapted to having two separate configuration
1974 * files.
1975 * Future minor releases of Mbed TLS may make minor changes to those
1976 * symbols, but we will endeavor to provide a transition path.
1977 * Nonetheless, this option is considered mature enough to use in
1978 * production, as long as you accept that you may need to make
1979 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001980 */
1981//#define MBEDTLS_PSA_CRYPTO_CONFIG
1982
1983/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001984 * \def MBEDTLS_VERSION_FEATURES
1985 *
1986 * Allow run-time checking of compile-time enabled features. Thus allowing users
1987 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001988 * support via mbedtls_version_check_feature().
1989 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001990 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00001991 *
1992 * Comment this to disable run-time checking and save ROM space
1993 */
1994#define MBEDTLS_VERSION_FEATURES
1995
1996/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001997 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1998 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001999 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002000 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2001 * the set of trusted certificates through a callback instead of a linked
2002 * list.
2003 *
2004 * This is useful for example in environments where a large number of trusted
2005 * certificates is present and storing them in a linked list isn't efficient
2006 * enough, or when the set of trusted certificates changes frequently.
2007 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002008 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002009 * `mbedtls_ssl_conf_ca_cb()` for more information.
2010 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002011 * Requires: MBEDTLS_X509_CRT_PARSE_C
2012 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002013 * Uncomment to enable trusted certificate callbacks.
2014 */
2015//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2016
2017/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002018 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002019 *
Chris Jones2c745862020-12-16 11:41:06 +00002020 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002021 *
Chris Jones2c745862020-12-16 11:41:06 +00002022 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002023 * and other functions/constants only used by these functions, thus reducing
2024 * the code footprint by several KB.
2025 */
Chris Jones2c745862020-12-16 11:41:06 +00002026//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002027
2028/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002030 *
2031 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2032 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2033 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002034 * Requires: MBEDTLS_PKCS1_V21
2035 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002036 * Comment this macro to disallow using RSASSA-PSS in certificates.
2037 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002039/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002040
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002041/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002042 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002043 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002044 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002045 * \{
2046 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002047
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002050 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002051 * Enable AES-NI support on x86-64 or x86-32.
2052 *
2053 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002054 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002055 * - GCC, x86-64, target not explicitly supporting AESNI:
2056 * requires MBEDTLS_HAVE_ASM.
2057 * - GCC, x86-32, target not explicitly supporting AESNI:
2058 * not supported.
2059 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2060 * For this assembly-less implementation, you must currently compile
2061 * `library/aesni.c` and `library/aes.c` with machine options to enable
2062 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2063 * `clang -maes -mpclmul`.
2064 * - Non-x86 targets: this option is silently ignored.
2065 * - Other compilers: this option is silently ignored.
2066 *
2067 * \note
2068 * Above, "GCC" includes compatible compilers such as Clang.
2069 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002070 *
2071 * Module: library/aesni.c
2072 * Caller: library/aes.c
2073 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002074 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002075 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002076 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002079
2080/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002081 * \def MBEDTLS_AESCE_C
2082 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002083 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002084 *
2085 * Module: library/aesce.c
2086 * Caller: library/aes.c
2087 *
Jerry Yuf015a932023-04-25 10:38:03 +08002088 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002090 * \warning Runtime detection only works on Linux. For non-Linux operating
2091 * system, Armv8-A Cryptographic Extensions must be supported by
2092 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002093 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002094 * \note Minimum compiler versions for this feature when targeting aarch64
2095 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2096 * Minimum compiler versions for this feature when targeting 32-bit
2097 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002098 *
2099 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2100 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002101 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002102 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002103 */
2104#define MBEDTLS_AESCE_C
2105
2106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002107 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002108 *
2109 * Enable the AES block cipher.
2110 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002111 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002112 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002113 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002114 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002115 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002116 * This module enables the following ciphersuites (if other requisites are
2117 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2119 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2120 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2121 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2123 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2127 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2129 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2130 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2132 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2142 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2143 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2144 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2145 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2146 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2147 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2148 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2149 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2150 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2151 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2152 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2156 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2157 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2158 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2159 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2160 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2161 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2162 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2164 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2165 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2166 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2170 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2171 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2172 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2173 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2174 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2175 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002176 *
Paul Bakkercff68422013-09-15 20:43:33 +02002177 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002180
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002183 *
2184 * Enable the generic ASN1 parser.
2185 *
2186 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002187 * Caller: library/x509.c
2188 * library/dhm.c
2189 * library/pkcs12.c
2190 * library/pkcs5.c
2191 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002194
2195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002197 *
2198 * Enable the generic ASN1 writer.
2199 *
2200 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002201 * Caller: library/ecdsa.c
2202 * library/pkwrite.c
2203 * library/x509_create.c
2204 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002205 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002208
2209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002211 *
2212 * Enable the Base64 module.
2213 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002214 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002215 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002216 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002217 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002218 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002220
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002221/**
Yanray Wange367e472023-10-31 17:23:04 +08002222 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2223 *
2224 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2225 *
2226 * \note This feature is incompatible with insecure block cipher,
2227 * MBEDTLS_DES_C, and cipher modes which always require decryption
2228 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002229 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2230 * this feature is incompatible with following supported PSA equivalence,
2231 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2232 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002233 *
2234 * Module: library/aes.c
2235 * library/aesce.c
2236 * library/aesni.c
2237 * library/aria.c
2238 * library/camellia.c
2239 * library/cipher.c
2240 */
2241//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2242
2243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002244 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002245 *
Paul Bakker9a736322012-11-14 12:39:52 +00002246 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002247 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002248 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002249 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002250 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002251 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002252 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002253 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002254 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002255 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002256 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002257 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002259 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002262
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002265 *
2266 * Enable the Camellia block cipher.
2267 *
Paul Bakker38119b12009-01-10 23:31:23 +00002268 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002269 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002270 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002271 * This module enables the following ciphersuites (if other requisites are
2272 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002273 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2274 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2275 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2276 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2277 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2278 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2279 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2280 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2281 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2285 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2286 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2287 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2288 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2289 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2290 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2293 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2294 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2295 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2296 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2297 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2298 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2299 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2300 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2301 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2302 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2303 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2304 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2305 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2307 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2308 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2309 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2310 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2311 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2312 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2313 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2314 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002317
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002318/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002319 * \def MBEDTLS_ARIA_C
2320 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002321 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002322 *
2323 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002324 * Caller: library/cipher.c
2325 *
2326 * This module enables the following ciphersuites (if other requisites are
2327 * enabled as well):
2328 *
2329 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2332 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2333 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2334 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2335 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2342 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2343 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2344 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2345 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2346 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2347 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2354 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2355 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2356 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2357 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2358 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2359 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2360 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2361 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2362 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2363 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2364 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2365 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2366 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002367 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002368#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002369
2370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002371 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002372 *
2373 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2374 *
2375 * Module: library/ccm.c
2376 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002377 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2378 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002379 *
2380 * This module enables the AES-CCM ciphersuites, if other requisites are
2381 * enabled as well.
2382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002384
2385/**
Daniel King34b822c2016-05-15 17:28:08 -03002386 * \def MBEDTLS_CHACHA20_C
2387 *
2388 * Enable the ChaCha20 stream cipher.
2389 *
2390 * Module: library/chacha20.c
2391 */
2392#define MBEDTLS_CHACHA20_C
2393
2394/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002395 * \def MBEDTLS_CHACHAPOLY_C
2396 *
2397 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2398 *
2399 * Module: library/chachapoly.c
2400 *
2401 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2402 */
2403#define MBEDTLS_CHACHAPOLY_C
2404
2405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002407 *
2408 * Enable the generic cipher layer.
2409 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002410 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002411 * Caller: library/ccm.c
2412 * library/cmac.c
2413 * library/gcm.c
2414 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002415 * library/pkcs12.c
2416 * library/pkcs5.c
2417 * library/psa_crypto_aead.c
2418 * library/psa_crypto_mac.c
2419 * library/ssl_ciphersuites.c
2420 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002421 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002422 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2423 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002424 *
2425 * Uncomment to enable generic cipher wrappers.
2426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002428
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002429/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002430 * \def MBEDTLS_CMAC_C
2431 *
Simon Butcher327398a2016-10-05 14:09:11 +01002432 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2433 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002434 *
2435 * Module: library/cmac.c
2436 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002437 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002438 *
2439 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002440#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002441
2442/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002444 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002445 * Enable the CTR_DRBG AES-based random generator.
2446 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002447 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002448 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002449 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002450 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2451 * is used.
2452 *
2453 * \warning When using PSA, the user should call `psa_crypto_init()` before
2454 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2455 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002456 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2457 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002458 * \note To achieve a 256-bit security strength with CTR_DRBG,
2459 * you must use AES-256 *and* use sufficient entropy.
2460 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002461 *
2462 * Module: library/ctr_drbg.c
2463 * Caller:
2464 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002465 * Requires: MBEDTLS_AES_C or
2466 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2467 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002468 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002469 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002472
2473/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002475 *
2476 * Enable the debug functions.
2477 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002478 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002479 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002480 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002481 * library/ssl_tls12_*.c
2482 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002483 *
2484 * This module provides debugging functions.
2485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002487
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490 *
2491 * Enable the DES block cipher.
2492 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002493 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002494 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002495 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002496 *
Paul Bakkercff68422013-09-15 20:43:33 +02002497 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002498 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002499 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002500 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002503
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002506 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002507 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002508 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002510 * Caller: library/ssl_tls.c
2511 * library/ssl*_client.c
2512 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002514 * This module is used by the following key exchanges:
2515 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002516 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002517 * \warning Using DHE constitutes a security risk as it
2518 * is not possible to validate custom DH parameters.
2519 * If possible, it is recommended users should consider
2520 * preferring other methods of key exchange.
2521 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002522 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002523 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002525
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002528 *
2529 * Enable the elliptic curve Diffie-Hellman library.
2530 *
2531 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002532 * Caller: library/psa_crypto.c
2533 * library/ssl_tls.c
2534 * library/ssl*_client.c
2535 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002536 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002537 * This module is used by the following key exchanges:
2538 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002539 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002543
2544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002546 *
2547 * Enable the elliptic curve DSA library.
2548 *
2549 * Module: library/ecdsa.c
2550 * Caller:
2551 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002552 * This module is used by the following key exchanges:
2553 * ECDHE-ECDSA
2554 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002555 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2556 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2557 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560
2561/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002562 * \def MBEDTLS_ECJPAKE_C
2563 *
2564 * Enable the elliptic curve J-PAKE library.
2565 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002566 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2567 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002568 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002569 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002570 * Module: library/ecjpake.c
2571 * Caller:
2572 *
2573 * This module is used by the following key exchanges:
2574 * ECJPAKE
2575 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002576 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002577 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002578 * \warning If using a hash that is only provided by PSA drivers, you must
2579 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002580 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002581#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002582
2583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002585 *
2586 * Enable the elliptic curve over GF(p) library.
2587 *
2588 * Module: library/ecp.c
2589 * Caller: library/ecdh.c
2590 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002591 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596
2597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002599 *
2600 * Enable the platform-specific entropy code.
2601 *
2602 * Module: library/entropy.c
2603 * Caller:
2604 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002606 *
2607 * This module provides a generic entropy pool
2608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002610
2611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002613 *
2614 * Enable error code to error string conversion.
2615 *
2616 * Module: library/error.c
2617 * Caller:
2618 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002622
2623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002625 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002626 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002627 *
2628 * Module: library/gcm.c
2629 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002630 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2631 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002632 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002633 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2634 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002637
2638/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002639 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002640 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002641 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002642 * Can significantly increase throughput on systems without GCM hardware
2643 * acceleration (e.g., AESNI, AESCE).
2644 *
Matthias Schulz78266782024-02-08 13:54:48 +01002645 * The mbedtls_gcm_context size will increase by 3840 bytes.
2646 * The code size will increase by roughly 344 bytes.
2647 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002648 * Module: library/gcm.c
2649 *
2650 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002651 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002652//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002653
2654/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002655 * \def MBEDTLS_HKDF_C
2656 *
2657 * Enable the HKDF algorithm (RFC 5869).
2658 *
2659 * Module: library/hkdf.c
2660 * Caller:
2661 *
2662 * Requires: MBEDTLS_MD_C
2663 *
2664 * This module adds support for the Hashed Message Authentication Code
2665 * (HMAC)-based key derivation function (HKDF).
2666 */
2667#define MBEDTLS_HKDF_C
2668
2669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002671 *
2672 * Enable the HMAC_DRBG random generator.
2673 *
2674 * Module: library/hmac_drbg.c
2675 * Caller:
2676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002678 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002679 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002682
2683/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002684 * \def MBEDTLS_LMS_C
2685 *
2686 * Enable the LMS stateful-hash asymmetric signature algorithm.
2687 *
2688 * Module: library/lms.c
2689 * Caller:
2690 *
Raef Colesab4f8742022-09-01 12:24:31 +01002691 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002692 *
Raef Colesab4f8742022-09-01 12:24:31 +01002693 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002694 */
2695#define MBEDTLS_LMS_C
2696
2697/**
Raef Colesab4f8742022-09-01 12:24:31 +01002698 * \def MBEDTLS_LMS_PRIVATE
2699 *
2700 * Enable LMS private-key operations and signing code. Functions enabled by this
2701 * option are experimental, and should not be used in production.
2702 *
2703 * Requires: MBEDTLS_LMS_C
2704 *
2705 * Uncomment to enable the LMS signature algorithm and private key operations.
2706 */
Raef Coles5127e852022-10-07 10:35:56 +01002707//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002708
2709/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002710 * \def MBEDTLS_NIST_KW_C
2711 *
2712 * Enable the Key Wrapping mode for 128-bit block ciphers,
2713 * as defined in NIST SP 800-38F. Only KW and KWP modes
2714 * are supported. At the moment, only AES is approved by NIST.
2715 *
2716 * Module: library/nist_kw.c
2717 *
2718 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2719 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002720#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002721
2722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002724 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002725 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002726 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002727 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2728 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002729 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002730 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002731 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002732 * Caller: library/constant_time.c
2733 * library/ecdsa.c
2734 * library/ecjpake.c
2735 * library/hkdf.c
2736 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002737 * library/pk.c
2738 * library/pkcs5.c
2739 * library/pkcs12.c
2740 * library/psa_crypto_ecp.c
2741 * library/psa_crypto_rsa.c
2742 * library/rsa.c
2743 * library/ssl_cookie.c
2744 * library/ssl_msg.c
2745 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002746 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002747 * library/x509_crt.c
2748 * library/x509write_crt.c
2749 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002750 *
2751 * Uncomment to enable generic message digest wrappers.
2752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002754
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002757 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002758 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002760 * Module: library/md5.c
2761 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002762 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002763 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002764 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002765 * This module is required for TLS 1.2 depending on the handshake parameters.
2766 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2767 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002768 *
2769 * \warning MD5 is considered a weak message digest and its use constitutes a
2770 * security risk. If possible, we recommend avoiding dependencies on
2771 * it, and considering stronger message digests instead.
2772 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002775
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002776/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002778 *
2779 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002780 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002781 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002782 *
2783 * Module: library/memory_buffer_alloc.c
2784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002786 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002787 *
2788 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002791
2792/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002794 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002795 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2796 *
Simon Butcherd567a232016-03-09 20:19:21 +00002797 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2798 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002799 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002800 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002801 * \note See also our Knowledge Base article about porting to a new
2802 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002803 * 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 +00002804 *
Andres AG788aa4a2016-09-14 14:32:09 +01002805 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002806 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002807 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002810
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002813 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002814 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002815 *
2816 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002817 * Caller: library/asn1write.c
2818 * library/pkcs5.c
2819 * library/pkparse.c
2820 * library/pkwrite.c
2821 * library/rsa.c
2822 * library/x509.c
2823 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002824 * library/x509_crl.c
2825 * library/x509_crt.c
2826 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002827 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002828 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002829 *
2830 * This modules translates between OIDs and internal values.
2831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002833
2834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002837 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002838 *
2839 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002840 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002841 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002842 * library/x509_crl.c
2843 * library/x509_crt.c
2844 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002847 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2848 *
2849 * \warning When parsing password-protected files, if MD5 is provided only by
2850 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002851 *
Paul Bakkercff68422013-09-15 20:43:33 +02002852 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002853 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002855
2856/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002858 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002859 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002860 *
2861 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002862 * Caller: library/pkwrite.c
2863 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002864 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002867 *
2868 * This modules adds support for encoding / writing PEM files.
2869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002871
2872/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002874 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002875 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002876 *
2877 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002878 * Caller: library/psa_crypto_rsa.c
2879 * library/ssl_tls.c
2880 * library/ssl*_client.c
2881 * library/ssl*_server.c
2882 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002883 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002884 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002885 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002886 * Uncomment to enable generic public key wrappers.
2887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002889
2890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002892 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002893 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002894 *
2895 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002896 * Caller: library/x509_crt.c
2897 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002898 *
Yanray Wang072a0682023-12-05 10:53:04 +08002899 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002900 *
2901 * Uncomment to enable generic public key parse functions.
2902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002904
2905/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002906 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002907 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002908 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002909 *
2910 * Module: library/pkwrite.c
2911 * Caller: library/x509write.c
2912 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002913 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002914 *
2915 * Uncomment to enable generic public key write functions.
2916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002917#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002918
2919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002920 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002921 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002922 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002923 *
2924 * Module: library/pkcs5.c
2925 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002926 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002927 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002928 * \warning If using a hash that is only provided by PSA drivers, you must
2929 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002930 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002931 * This module adds support for the PKCS#5 functions.
2932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002934
2935/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002936 * \def MBEDTLS_PKCS7_C
2937 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002938 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002939 * RFC Link - https://tools.ietf.org/html/rfc2315
2940 *
2941 * Module: library/pkcs7.c
2942 *
2943 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002944 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2945 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002946 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002947 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002948 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002949#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002950
2951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002953 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002954 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002955 * Adds algorithms for parsing PKCS#8 encrypted private keys
2956 *
2957 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002958 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002959 *
Valerio Settie98ad592023-12-28 10:42:12 +01002960 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2961 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002962 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002963 * \warning If using a hash that is only provided by PSA drivers, you must
2964 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002965 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002966 * This module enables PKCS#12 functions.
2967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002969
2970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002972 *
2973 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002974 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002975 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2977 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002978 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002979 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002980 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002981 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002982 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002983 * Module: library/platform.c
2984 * Caller: Most other .c files
2985 *
2986 * This module enables abstraction of common (libc) functions.
2987 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002988#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002989
2990/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002991 * \def MBEDTLS_POLY1305_C
2992 *
2993 * Enable the Poly1305 MAC algorithm.
2994 *
2995 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002996 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002997 */
2998#define MBEDTLS_POLY1305_C
2999
3000/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003001 * \def MBEDTLS_PSA_CRYPTO_C
3002 *
3003 * Enable the Platform Security Architecture cryptography API.
3004 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003005 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003006 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003007 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003008 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003009 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3010 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3011 * is enabled in PSA (unless it's fully accelerated, see
3012 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003013 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003014#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003015
3016/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003017 * \def MBEDTLS_PSA_CRYPTO_SE_C
3018 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003019 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003020 * cryptography API.
3021 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003022 * \deprecated This feature is deprecated. Please switch to the PSA driver
3023 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003024 *
Ryan Everett32a64582024-03-05 18:16:18 +00003025 * \warning This feature is not thread-safe, and should not be used in a
3026 * multi-threaded environment.
3027 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003028 * Module: library/psa_crypto_se.c
3029 *
3030 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3031 *
3032 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003033//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003034
3035/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003036 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3037 *
3038 * Enable the Platform Security Architecture persistent key storage.
3039 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003040 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003041 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003042 * Requires: MBEDTLS_PSA_CRYPTO_C,
3043 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3044 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003045 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003046#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003047
3048/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003049 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003050 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003051 * Enable the emulation of the Platform Security Architecture
3052 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003053 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003054 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003055 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003056 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003057 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003058#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003059
3060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003062 *
3063 * Enable the RIPEMD-160 hash algorithm.
3064 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003065 * Module: library/ripemd160.c
3066 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003067 *
3068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003070
3071/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003072 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003073 *
3074 * Enable the RSA public-key cryptosystem.
3075 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003076 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003077 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003078 * Caller: library/pk.c
3079 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003080 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003081 * library/ssl*_client.c
3082 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003084 * This module is used by the following key exchanges:
3085 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003086 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003090
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003093 *
3094 * Enable the SHA1 cryptographic hash algorithm.
3095 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003096 * Module: library/sha1.c
3097 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003098 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003099 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003100 * This module is required for TLS 1.2 depending on the handshake parameters,
3101 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003102 *
3103 * \warning SHA-1 is considered a weak message digest and its use constitutes
3104 * a security risk. If possible, we recommend avoiding dependencies
3105 * on it, and considering stronger message digests instead.
3106 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003109
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003110/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003111 * \def MBEDTLS_SHA224_C
3112 *
3113 * Enable the SHA-224 cryptographic hash algorithm.
3114 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003115 * Module: library/sha256.c
3116 * Caller: library/md.c
3117 * library/ssl_cookie.c
3118 *
3119 * This module adds support for SHA-224.
3120 */
3121#define MBEDTLS_SHA224_C
3122
3123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003125 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003126 * Enable the SHA-256 cryptographic hash algorithm.
3127 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003128 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003129 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003130 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003131 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003132 * library/ssl*_client.c
3133 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003134 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003135 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003136 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003138#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003139
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003140/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003141 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003142 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003143 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3144 * with the ARMv8 cryptographic extensions if they are available at runtime.
3145 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003146 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003147 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003148 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003149 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003150 * \note Minimum compiler versions for this feature are Clang 4.0,
3151 * armclang 6.6 or GCC 6.0.
3152 *
3153 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3154 * armclang <= 6.9
3155 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003156 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3157 * That name is deprecated, but may still be used as an alternative form for this
3158 * option.
3159 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003160 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3161 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003162 *
3163 * Requires: MBEDTLS_SHA256_C.
3164 *
3165 * Module: library/sha256.c
3166 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003167 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003168 * and use them if available.
3169 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003170//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003171
Dave Rodgmand85277c2023-10-13 09:22:54 +01003172/**
3173 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3174 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003175 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003176 * This name is now deprecated, but may still be used as an alternative form for
3177 * this option.
3178 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3180
3181/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003182 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003183 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003184 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3185 * with the ARMv8 cryptographic extensions, which must be available at runtime
3186 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003187 *
3188 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003189 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003190 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003191 * \note Minimum compiler versions for this feature are Clang 4.0,
3192 * armclang 6.6 or GCC 6.0.
3193 *
3194 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3195 * armclang <= 6.9
3196 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003197 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003198 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003199 * option.
3200 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003201 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3202 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003203 *
3204 * Requires: MBEDTLS_SHA256_C.
3205 *
3206 * Module: library/sha256.c
3207 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003208 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003209 * unconditionally.
3210 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003211//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003212
Dave Rodgmand85277c2023-10-13 09:22:54 +01003213/**
3214 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3215 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003216 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003217 * This name is now deprecated, but may still be used as an alternative form for
3218 * this option.
3219 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003220//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3221
3222/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003223 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003224 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003225 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003226 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003227 * Module: library/sha512.c
3228 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003229 * library/psa_crypto_hash.c
3230 * library/ssl_tls.c
3231 * library/ssl*_client.c
3232 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003233 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003234 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003235 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003236#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003237
3238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003240 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003241 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003242 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003243 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003244 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003245 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003246 * library/ssl_tls.c
3247 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003249 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003251#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003252
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003253/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003254 * \def MBEDTLS_SHA3_C
3255 *
3256 * Enable the SHA3 cryptographic hash algorithm.
3257 *
3258 * Module: library/sha3.c
3259 *
3260 * This module adds support for SHA3.
3261 */
3262#define MBEDTLS_SHA3_C
3263
3264/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003265 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3266 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003267 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3268 * with the ARMv8 cryptographic extensions if they are available at runtime.
3269 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003270 *
3271 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3272 * for a non-Aarch64 build it will be silently ignored.
3273 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003274 * \note Minimum compiler versions for this feature are Clang 7.0,
3275 * armclang 6.9 or GCC 8.0.
3276 *
3277 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3278 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003279 *
3280 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3281 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3282 *
3283 * Requires: MBEDTLS_SHA512_C.
3284 *
3285 * Module: library/sha512.c
3286 *
3287 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3288 * and use them if available.
3289 */
3290//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3291
3292/**
3293 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3294 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003295 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3296 * with the ARMv8 cryptographic extensions, which must be available at runtime
3297 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003298 *
3299 * \note This allows builds with a smaller code size than with
3300 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3301 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003302 * \note Minimum compiler versions for this feature are Clang 7.0,
3303 * armclang 6.9 or GCC 8.0.
3304 *
3305 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3306 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003307 *
3308 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3309 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3310 *
3311 * Requires: MBEDTLS_SHA512_C.
3312 *
3313 * Module: library/sha512.c
3314 *
3315 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3316 * unconditionally.
3317 */
3318//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3319
3320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003322 *
3323 * Enable simple SSL cache implementation.
3324 *
3325 * Module: library/ssl_cache.c
3326 * Caller:
3327 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003331
3332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003334 *
3335 * Enable basic implementation of DTLS cookies for hello verification.
3336 *
3337 * Module: library/ssl_cookie.c
3338 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003341
3342/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003343 * \def MBEDTLS_SSL_TICKET_C
3344 *
3345 * Enable an implementation of TLS server-side callbacks for session tickets.
3346 *
3347 * Module: library/ssl_ticket.c
3348 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003349 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003350 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3351 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003352 */
3353#define MBEDTLS_SSL_TICKET_C
3354
3355/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003357 *
3358 * Enable the SSL/TLS client code.
3359 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003360 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003361 * Caller:
3362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003364 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003365 * This module is required for SSL/TLS client support.
3366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003368
Paul Bakker9a736322012-11-14 12:39:52 +00003369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003371 *
3372 * Enable the SSL/TLS server code.
3373 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003374 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003375 * Caller:
3376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003378 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003379 * This module is required for SSL/TLS server support.
3380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003382
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003385 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003386 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003387 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003388 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003389 * Caller: library/ssl*_client.c
3390 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3393 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003394 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003395 * This module is required for SSL/TLS.
3396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003398
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003401 *
3402 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003403 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003404 * contexts are not shared between threads. If you do intend to use contexts
3405 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003406 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003407 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003408 *
3409 * Module: library/threading.c
3410 *
3411 * This allows different threading implementations (self-implemented or
3412 * provided).
3413 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * You will have to enable either MBEDTLS_THREADING_ALT or
3415 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003416 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003417 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003420
3421/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003423 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003424 * Enable the semi-portable timing interface.
3425 *
Simon Butcherd567a232016-03-09 20:19:21 +00003426 * \note The provided implementation only works on POSIX/Unix (including Linux,
3427 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003428 * module and provide your own implementations of the callbacks needed by
3429 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3430 * your own implementation of the whole module by setting
3431 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003432 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003433 * \note The timing module will include time.h on suitable platforms
3434 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3435 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3436 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003437 * \note See also our Knowledge Base article about porting to a new
3438 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003439 * 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 +00003440 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003441 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003444
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003447 *
3448 * Enable run-time version information.
3449 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003450 * Module: library/version.c
3451 *
3452 * This module provides run-time version information.
3453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003455
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003456/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003458 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003459 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003460 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003461 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003462 * Caller: library/x509_crl.c
3463 * library/x509_crt.c
3464 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003465 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003466 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003467 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3468 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003469 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3470 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003471 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003472 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003475
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003476/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003478 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003479 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003480 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003481 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003482 * Caller: library/ssl_tls.c
3483 * library/ssl*_client.c
3484 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003485 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003486 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003487 *
3488 * This module is required for X.509 certificate parsing.
3489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491
3492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003494 *
3495 * Enable X.509 CRL parsing.
3496 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003497 * Module: library/x509_crl.c
3498 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003499 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003500 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003501 *
3502 * This module is required for X.509 CRL parsing.
3503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003505
3506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003508 *
3509 * Enable X.509 Certificate Signing Request (CSR) parsing.
3510 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003511 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003512 * Caller: library/x509_crt_write.c
3513 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003515 *
3516 * This module is used for reading X.509 certificate request.
3517 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003518#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003519
3520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003522 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003523 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003524 *
3525 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003526 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003527 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003528 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3529 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003530 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3531 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003532 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003533 * This module is the basis for creating X.509 certificates and CSRs.
3534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003535#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003536
3537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003539 *
3540 * Enable creating X.509 certificates.
3541 *
3542 * Module: library/x509_crt_write.c
3543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003545 *
3546 * This module is required for X.509 certificate creation.
3547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003549
3550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003552 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003553 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003554 *
3555 * Module: library/x509_csr_write.c
3556 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003558 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003559 * This module is required for X.509 certificate request writing.
3560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003562
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003563/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003564
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003565/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003566 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003567 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003568 * This section contains Mbed TLS build settings that are not associated
3569 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003570 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003571 * \{
3572 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003573
Gilles Peskinea02c1242022-03-16 17:03:19 +01003574/**
3575 * \def MBEDTLS_CONFIG_FILE
3576 *
3577 * If defined, this is a header which will be included instead of
3578 * `"mbedtls/mbedtls_config.h"`.
3579 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003580 * Unlike other configuration options, this one must be defined on the
3581 * compiler command line: a definition in `mbedtls_config.h` would have
3582 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003583 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003584 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003585 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003586 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003587 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003588 * The value of this symbol is typically a path in double quotes, either
3589 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003590 */
3591//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3592
3593/**
3594 * \def MBEDTLS_USER_CONFIG_FILE
3595 *
3596 * If defined, this is a header which will be included after
3597 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003598 * This allows you to modify the default configuration, including the ability
3599 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003600 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003601 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003602 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003603 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003604 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003605 * The value of this symbol is typically a path in double quotes, either
3606 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003607 */
3608//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3609
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003610/**
3611 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3612 *
3613 * If defined, this is a header which will be included instead of
3614 * `"psa/crypto_config.h"`.
3615 * This header file specifies which cryptographic mechanisms are available
3616 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3617 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3618 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003619 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003620 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003621 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003622 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003623 * The value of this symbol is typically a path in double quotes, either
3624 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003625 */
3626//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3627
3628/**
3629 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3630 *
3631 * If defined, this is a header which will be included after
3632 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003633 * This allows you to modify the default configuration, including the ability
3634 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003635 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003636 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003637 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003638 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003639 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003640 * The value of this symbol is typically a path in double quotes, either
3641 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003642 */
3643//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3644
Gilles Peskineb1176f22023-02-22 22:07:28 +01003645/**
3646 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3647 *
3648 * If defined, this is a header which will be included instead of
3649 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3650 * as the one in Mbed TLS, but with definitions adapted to the platform on
3651 * which the library code will run.
3652 *
3653 * \note The required content of this header can vary from one version of
3654 * Mbed TLS to the next. Integrators who provide an alternative file
3655 * should review the changes in the original file whenever they
3656 * upgrade Mbed TLS.
3657 *
3658 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3659 * non-standard feature of the C language, so this feature is only available
3660 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3661 *
3662 * The value of this symbol is typically a path in double quotes, either
3663 * absolute or relative to a directory on the include search path.
3664 */
3665//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3666
3667/**
3668 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3669 *
3670 * If defined, this is a header which will be included instead of
3671 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3672 * as the one in Mbed TLS, but with definitions adapted to the environment
3673 * in which the library code will run. The typical use for this feature
3674 * is to provide alternative type definitions on the client side in
3675 * client-server integrations of PSA crypto, where operation structures
3676 * contain handles instead of cryptographic data.
3677 *
3678 * \note The required content of this header can vary from one version of
3679 * Mbed TLS to the next. Integrators who provide an alternative file
3680 * should review the changes in the original file whenever they
3681 * upgrade Mbed TLS.
3682 *
3683 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3684 * non-standard feature of the C language, so this feature is only available
3685 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3686 *
3687 * The value of this symbol is typically a path in double quotes, either
3688 * absolute or relative to a directory on the include search path.
3689 */
3690//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3691
Gilles Peskineba4162a2022-04-11 17:04:38 +02003692/** \} name SECTION: General configuration options */
3693
3694/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003695 * \name SECTION: Module configuration options
3696 *
3697 * This section allows for the setting of module specific sizes and
3698 * configuration options. The default values are already present in the
3699 * relevant header files and should suffice for the regular use cases.
3700 *
3701 * Our advice is to enable options and change their values here
3702 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003703 * \{
3704 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003705/* The Doxygen documentation here is used when a user comments out a
3706 * setting and runs doxygen themselves. On the other hand, when we typeset
3707 * the full documentation including disabled settings, the documentation
3708 * in specific modules' header files is used if present. When editing this
3709 * file, make sure that each option is documented in exactly one place,
3710 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3711 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003712
Paul Bakker088c5c52014-04-25 11:11:10 +02003713/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003714//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003715//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003716
Paul Bakker088c5c52014-04-25 11:11:10 +02003717/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3719//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3720//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3721//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3722//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003723
Paul Bakker088c5c52014-04-25 11:11:10 +02003724/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003725//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3726//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3727//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3728//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003729
Paul Bakker088c5c52014-04-25 11:11:10 +02003730/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003731//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003732//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003733
Paul Bakker088c5c52014-04-25 11:11:10 +02003734/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003735//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3736//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003737//#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 +01003738
Paul Bakker088c5c52014-04-25 11:11:10 +02003739/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003740//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003741
Paul Bakker088c5c52014-04-25 11:11:10 +02003742/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003743//#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 -04003744
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003745/** \def MBEDTLS_PLATFORM_STD_CALLOC
3746 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003747 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003748 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003749 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003750 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003751 * 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 -04003752 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3753 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003754 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003755 */
3756//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003757
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003758/** \def MBEDTLS_PLATFORM_STD_FREE
3759 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003760 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003761 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003762 * 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 -04003763 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3764 * 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 -04003765 */
3766//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003767//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003768//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003769//#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 +02003770//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3771//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003772/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003774//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3775//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003776//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3777//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3778//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003779
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003780/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003781/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003782//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3783//#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 +02003784//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003785//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003786//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3787//#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 +02003788//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3789//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003790/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003791//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003792//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003793//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3794//#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 +08003795//#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 +08003796//#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 +02003797
Gilles Peskine3f106f72021-09-23 17:42:39 +02003798/** \def MBEDTLS_CHECK_RETURN
3799 *
3800 * This macro is used at the beginning of the declaration of a function
3801 * to indicate that its return value should be checked. It should
3802 * instruct the compiler to emit a warning or an error if the function
3803 * is called without checking its return value.
3804 *
3805 * There is a default implementation for popular compilers in platform_util.h.
3806 * You can override the default implementation by defining your own here.
3807 *
3808 * If the implementation here is empty, this will effectively disable the
3809 * checking of functions' return values.
3810 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003811//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003812
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003813/** \def MBEDTLS_IGNORE_RETURN
3814 *
3815 * This macro requires one argument, which should be a C function call.
3816 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3817 * warning is suppressed.
3818 */
3819//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3820
Gilles Peskineed038902020-11-13 21:33:21 +01003821/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003822/**
Gilles Peskineed038902020-11-13 21:33:21 +01003823 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3824 * PSA crypto subsystem.
3825 *
3826 * If this option is unset:
3827 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003828 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003829 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3830 * on unspecified heuristics.
3831 */
3832//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3833
Steven Cooreman863470a2021-02-15 14:03:19 +01003834/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003835 * Restrict the PSA library to supporting a maximum amount of simultaneously
3836 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3837 * volatile key, or a persistent key which is loaded temporarily by the
3838 * library as part of a crypto operation in flight.
3839 *
3840 * If this option is unset, the library will fall back to a default value of
3841 * 32 keys.
3842 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003843//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003844
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003845/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003846//#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 +00003847
Paul Bakker088c5c52014-04-25 11:11:10 +02003848/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003849//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3850//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003851
Paul Bakker088c5c52014-04-25 11:11:10 +02003852/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003853
Angus Grattond8213d02016-05-25 20:56:48 +10003854/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3855 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003856 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003857 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003858 * This determines the size of the incoming TLS I/O buffer in such a way
3859 * that it is capable of holding the specified amount of plaintext data,
3860 * regardless of the protection mechanism used.
3861 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003862 * \note When using a value less than the default of 16KB on the client, it is
3863 * recommended to use the Maximum Fragment Length (MFL) extension to
3864 * inform the server about this limitation. On the server, there
3865 * is no supported, standardized way of informing the client about
3866 * restriction on the maximum size of incoming messages, and unless
3867 * the limitation has been communicated by other means, it is recommended
3868 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3869 * while keeping the default value of 16KB for the incoming buffer.
3870 *
David Horstmann95d516f2021-05-04 18:36:56 +01003871 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003872 */
3873//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3874
Gilles Peskined3d02902020-03-04 21:35:27 +01003875/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3876 *
3877 * The maximum length of CIDs used for incoming DTLS messages.
3878 *
3879 */
3880//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3881
3882/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3883 *
3884 * The maximum length of CIDs used for outgoing DTLS messages.
3885 *
3886 */
3887//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3888
TRodziewicze8dd7092021-05-12 14:19:11 +02003889/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003890 *
3891 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003892 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003893 *
3894 * The padding will always be chosen so that the length of the
3895 * padded plaintext is a multiple of the value of this option.
3896 *
3897 * Note: A value of \c 1 means that no padding will be used
3898 * for outgoing records.
3899 *
3900 * Note: On systems lacking division instructions,
3901 * a power of two should be preferred.
3902 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003903//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003904
Angus Grattond8213d02016-05-25 20:56:48 +10003905/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3906 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003907 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003908 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003909 * This determines the size of the outgoing TLS I/O buffer in such a way
3910 * that it is capable of holding the specified amount of plaintext data,
3911 * regardless of the protection mechanism used.
3912 *
Angus Grattond8213d02016-05-25 20:56:48 +10003913 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3914 * the default inward 16384 byte buffer to conform to the TLS specification.
3915 *
3916 * The minimum required outward buffer size is determined by the handshake
3917 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3918 * The specific size requirement depends on the configured ciphers and any
3919 * certificate data which is sent during the handshake.
3920 *
David Horstmann95d516f2021-05-04 18:36:56 +01003921 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003922 */
3923//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3924
Hanno Beckere0b150f2018-08-21 15:51:03 +01003925/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3926 *
3927 * Maximum number of heap-allocated bytes for the purpose of
3928 * DTLS handshake message reassembly and future message buffering.
3929 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003930 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003931 * to account for a reassembled handshake message of maximum size,
3932 * together with its reassembly bitmap.
3933 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003934 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003935 * should be sufficient for all practical situations as it allows
3936 * to reassembly a large handshake message (such as a certificate)
3937 * while buffering multiple smaller handshake messages.
3938 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003939 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003940//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003941
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003942//#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 +02003943//#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 +02003944
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003945/**
3946 * Complete list of ciphersuites to use, in order of preference.
3947 *
3948 * \warning No dependency checking is done on that field! This option can only
3949 * be used to restrict the set of available ciphersuites. It is your
3950 * responsibility to make sure the needed modules are active.
3951 *
3952 * Use this to save a few hundred bytes of ROM (default ordering of all
3953 * available ciphersuites) and a few to a few hundred bytes of RAM.
3954 *
3955 * The value below is only an example, not the default.
3956 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003957//#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 +02003958
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003959/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003960 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3961 *
3962 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003963 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003964 *
3965 * It must be positive and smaller than UINT32_MAX.
3966 *
3967 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3968 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003969 */
3970//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3971
3972/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003973 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3974 *
Jerry Yucf913512023-11-14 11:06:52 +08003975 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003976 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003977 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003978 * - The client ticket age is the time difference between the time when the
3979 * client proposes to the server to use the ticket and the time the client
3980 * received the ticket from the server.
3981 * - The server ticket age is the time difference between the time when the
3982 * server receives a proposition from the client to use the ticket and the
3983 * time when the ticket was created by the server.
3984 *
Jerry Yucf913512023-11-14 11:06:52 +08003985 * The ages might be different due to the client and server clocks not running
3986 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3987 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3988 * 6s, thus in the worst case clients and servers must sync up their system time
3989 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003990 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003991 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003992 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003993//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003994
3995/**
3996 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3997 *
3998 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3999 *
4000 * This must be less than 256.
4001 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004002//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004003
4004/**
4005 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4006 *
4007 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4008 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4009 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4010 *
4011 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004012//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004013
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004014/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004016//#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 +01004017
Gilles Peskine611179c2022-04-13 23:04:48 +02004018/** \} name SECTION: Module configuration options */