blob: 25ef0ca4ac65d224eeea50fa5a7d0ba48b87f574 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
353/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100354 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100357 * alternate core implementation of a symmetric crypto, an arithmetic or hash
358 * module (e.g. platform specific assembly optimized implementations). Keep
359 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200360 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000365 * provide the "struct mbedtls_aes_context" definition and omit the base
366 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200367 * "aes.h" to include the new function definitions.
368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * use constitutes a security risk. If possible, we recommend
374 * avoiding dependencies on them, and considering stronger message
375 * digests and ciphers instead.
376 *
Paul Bakker90995b52013-06-24 19:20:35 +0200377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200381//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300382//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200383//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200384//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385//#define MBEDTLS_DES_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000386//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100387//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300388//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300390//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391//#define MBEDTLS_RIPEMD160_ALT
392//#define MBEDTLS_SHA1_ALT
393//#define MBEDTLS_SHA256_ALT
394//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000395
Janos Follathb0697532016-08-18 12:38:46 +0100396/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800397 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100398 * implemented with two .c files:
399 * - ecp.c
400 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000401 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
402 * macros as described above. The only difference is that you have to make sure
403 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100404 */
405//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200406
407/**
TRodziewicz75628d52021-06-18 12:56:27 +0200408 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200409 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200410 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100411 * alternate core implementation of symmetric crypto or hash function. Keep in
412 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200413 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200414 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200416 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200417 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 * no longer provide the mbedtls_sha1_process() function, but it will still provide
419 * the other function (using your mbedtls_sha1_process() function) and the definition
420 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200421 * with this definition.
422 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200423 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100424 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
425 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200426 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200427 * Uncomment a macro to enable alternate implementation of the corresponding
428 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100429 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200430 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100431 * constitutes a security risk. If possible, we recommend avoiding
432 * dependencies on them, and considering stronger message digests
433 * and ciphers instead.
434 *
Janos Follath1231d212019-01-07 15:01:32 +0000435 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
436 * enabled, then the deterministic ECDH signature functions pass the
437 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
438 * alternative implementations should use the RNG only for generating
439 * the ephemeral key and nothing else. If this is not possible, then
440 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200441 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000442 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200444//#define MBEDTLS_MD5_PROCESS_ALT
445//#define MBEDTLS_RIPEMD160_PROCESS_ALT
446//#define MBEDTLS_SHA1_PROCESS_ALT
447//#define MBEDTLS_SHA256_PROCESS_ALT
448//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200449//#define MBEDTLS_DES_SETKEY_ALT
450//#define MBEDTLS_DES_CRYPT_ECB_ALT
451//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200452//#define MBEDTLS_AES_SETKEY_ENC_ALT
453//#define MBEDTLS_AES_SETKEY_DEC_ALT
454//#define MBEDTLS_AES_ENCRYPT_ALT
455//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300456//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300457//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300458//#define MBEDTLS_ECDSA_VERIFY_ALT
459//#define MBEDTLS_ECDSA_SIGN_ALT
460//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200461
462/**
Janos Follathc44ab972016-11-18 16:38:23 +0000463 * \def MBEDTLS_ECP_INTERNAL_ALT
464 *
465 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100466 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200467 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100468 * alternative core implementation of elliptic curve arithmetic. Keep in mind
469 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100470 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200471 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100472 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
473 * is still present and it is used for group structures not supported by the
474 * alternative.
475 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100476 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100477 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100478 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
479 * able to fallback to curves not supported by the alternative implementation.
480 *
Janos Follathc44ab972016-11-18 16:38:23 +0000481 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
482 * and implementing the following functions:
483 * unsigned char mbedtls_internal_ecp_grp_capable(
484 * const mbedtls_ecp_group *grp )
485 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500486 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000487 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
488 * replacement functions implement arithmetic for the given group and 0
489 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500490 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000491 * called before and after each point operation and provide an opportunity to
492 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100493 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100494 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200495 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100496 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
497 * for the operation is supported by your implementation (i.e. your
498 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200499 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100500 * implementation of ecp_double_jac() is used instead, unless this fallback
501 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
502 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
503 *
504 * The function prototypes and the definition of mbedtls_ecp_group and
505 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
506 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
507 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100508 *
509 * Uncomment a macro to enable alternate implementation of the corresponding
510 * function.
511 */
512/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000513//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100514/* Turn off software fallback for curves not supported in hardware */
515//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100516/* Support for Weierstrass curves with Jacobi representation */
517//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
518//#define MBEDTLS_ECP_ADD_MIXED_ALT
519//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
520//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
521//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
522/* Support for curves with Montgomery arithmetic */
523//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
524//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
525//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
526
527/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200528 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200529 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200530 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200531 * hardware entropy collector.
532 *
533 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000534 * prototype as declared in library/entropy_poll.h, and accept NULL as first
535 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200536 *
537 * Uncomment to use your own hardware entropy collector.
538 */
539//#define MBEDTLS_ENTROPY_HARDWARE_ALT
540
541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000543 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100544 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000545 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100546 * Uncomment this macro to use precomputed AES tables stored in ROM.
547 * Comment this macro to generate AES tables in RAM at runtime.
548 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100549 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
550 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100551 * initialization time before the first AES operation can be performed.
552 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
553 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
554 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100555 *
556 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000559
560/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100561 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200562 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100563 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200564 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100565 * Uncommenting this macro omits 75% of the AES tables from
566 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
567 * by computing their values on the fly during operations
568 * (the tables are entry-wise rotations of one another).
569 *
570 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100571 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100572 * runtime. Specifically, one has to compare 4 accesses within
573 * different tables to 4 accesses with additional arithmetic
574 * operations within the same table. The performance gain/loss
575 * depends on the system and memory details.
576 *
577 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200578 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580
581/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800582 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
583 *
584 * Use only 128-bit keys in AES operations to save ROM.
585 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800586 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800587 * or 256-bit keys.
588 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800589 * Uncommenting this macro reduces the size of AES code by ~300 bytes
590 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800591 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800592 * Module: library/aes.c
593 *
594 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800595 */
596//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
597
Gilles Peskinea8861e02023-09-05 20:20:51 +0200598/*
599 * Disable plain C implementation for AES.
600 *
601 * When the plain C implementation is enabled, and an implementation using a
602 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
603 * detection will be used to select between them.
604 *
605 * If only one implementation is present, runtime detection will not be used.
606 * This configuration will crash at runtime if running on a CPU without the
607 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
608 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
609 */
610//#define MBEDTLS_AES_USE_HARDWARE_ONLY
611
Arto Kinnunen732ca322023-04-14 14:26:10 +0800612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200613 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200614 *
615 * Use less ROM for the Camellia implementation (saves about 768 bytes).
616 *
617 * Uncomment this macro to use less memory for Camellia.
618 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200619//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200620
621/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200622 * \def MBEDTLS_CHECK_RETURN_WARNING
623 *
624 * If this macro is defined, emit a compile-time warning if application code
625 * calls a function without checking its return value, but the return value
626 * should generally be checked in portable applications.
627 *
628 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
629 * implemented. Otherwise this option has no effect.
630 *
631 * Uncomment to get warnings on using fallible functions without checking
632 * their return value.
633 *
634 * \note This feature is a work in progress.
635 * Warnings will be added to more functions in the future.
636 *
637 * \note A few functions are considered critical, and ignoring the return
638 * value of these functions will trigger a warning even if this
639 * macro is not defined. To completely disable return value check
640 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
641 */
642//#define MBEDTLS_CHECK_RETURN_WARNING
643
644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200646 *
647 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200649#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200650
651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200652 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000653 *
654 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000657
658/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000660 *
661 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000664
665/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100666 * \def MBEDTLS_CIPHER_MODE_OFB
667 *
668 * Enable Output Feedback mode (OFB) for symmetric ciphers.
669 */
670#define MBEDTLS_CIPHER_MODE_OFB
671
672/**
673 * \def MBEDTLS_CIPHER_MODE_XTS
674 *
675 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
676 */
677#define MBEDTLS_CIPHER_MODE_XTS
678
679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000681 *
682 * Enable NULL cipher.
683 * Warning: Only do so when you know what you are doing. This allows for
684 * encryption or channels without any security!
685 *
Ronald Croncee42702021-04-26 11:34:44 +0200686 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
688 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
689 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
690 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
691 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
692 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
693 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
694 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
695 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
696 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
697 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
698 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
699 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
700 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
701 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
702 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
703 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
704 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
705 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000706 *
707 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000710
711/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100712 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200713 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100714 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
715 * specific padding modes in the cipher layer with cipher modes that support
716 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200717 *
718 * If you disable all padding modes, only full blocks can be used with CBC.
719 *
720 * Enable padding modes in the cipher layer.
721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722#define MBEDTLS_CIPHER_PADDING_PKCS7
723#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
724#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
725#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200726
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200727/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
728 *
729 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800730 * Without this, CTR_DRBG uses a 256-bit key
731 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200732 */
733//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
734
Paul Bakker48e93c82013-08-14 12:21:18 +0200735/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200736 * Enable the verified implementations of ECDH primitives from Project Everest
737 * (currently only Curve25519). This feature changes the layout of ECDH
738 * contexts and therefore is a compatibility break for applications that access
739 * fields of a mbedtls_ecdh_context structure directly. See also
740 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000741 *
742 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
743 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200744 */
745//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
746
747/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100748 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200749 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100750 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
751 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200752 *
753 * Comment macros to disable the curve and functions for it
754 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200755/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
757#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
758#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
759#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
761#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
762#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
763#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
764#define MBEDTLS_ECP_DP_BP256R1_ENABLED
765#define MBEDTLS_ECP_DP_BP384R1_ENABLED
766#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200767/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200768#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000769#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200770
771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200773 *
774 * Enable specific 'modulo p' routines for each NIST prime.
775 * Depending on the prime and architecture, makes operations 4 to 8 times
776 * faster on the corresponding curve.
777 *
778 * Comment this macro to disable NIST curves optimisation.
779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200781
782/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200783 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100784 *
785 * Enable "non-blocking" ECC operations that can return early and be resumed.
786 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200787 * This allows various functions to pause by returning
788 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
789 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
790 * order to further progress and eventually complete their operation. This is
791 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
792 * number of ECC operations a function may perform before pausing; see
793 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100794 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200795 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200796 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100797 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100798 * This option:
799 * - Adds xxx_restartable() variants of existing operations in the
800 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100801 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
802 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100803 * - ECDSA: signature generation & verification;
804 * - PK: signature generation & verification;
805 * - X509: certificate chain verification.
806 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
807 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
808 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
809 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000810 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100811 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100812 * - verification of the server's key exchange signature;
813 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100814 * - generation of the client's signature if client authentication is used,
815 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100816 *
817 * \note In the cases above, the usual SSL/TLS functions, such as
818 * mbedtls_ssl_handshake(), can now return
819 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200820 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100821 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
822 * restartable operations in PK, X.509 and TLS (see above) are not
823 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100824 * PSA, and are not restartable. These are temporary limitations that
825 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200826 *
Ron Eldor19779c42018-11-05 16:58:13 +0200827 * \note This option only works with the default software implementation of
828 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100829 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100830 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100831 * Requires: MBEDTLS_ECP_C
832 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100833 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100834 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200835//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100836
837/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200838 * Uncomment to enable using new bignum code in the ECC modules.
839 *
840 * \warning This is currently experimental, incomplete and therefore should not
841 * be used in production.
842 */
843//#define MBEDTLS_ECP_WITH_MPI_UINT
844
845/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100847 *
848 * Enable deterministic ECDSA (RFC 6979).
849 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
850 * may result in a compromise of the long-term signing key. This is avoided by
851 * the deterministic variant.
852 *
John Durkop36a82e52020-10-26 09:39:05 -0700853 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100854 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100855 * Comment this macro to disable deterministic ECDSA.
856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100858
859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200862 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200863 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 * This enables the following ciphersuites (if other requisites are
865 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
867 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
868 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
869 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
870 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
871 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
872 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
873 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
874 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
875 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200878
879/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200882 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200885 *
886 * This enables the following ciphersuites (if other requisites are
887 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
889 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
890 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
891 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
892 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
893 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
894 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
895 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
896 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
897 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100898 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100899 * \warning Using DHE constitutes a security risk as it
900 * is not possible to validate custom DH parameters.
901 * If possible, it is recommended users should consider
902 * preferring other methods of key exchange.
903 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100904 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907
908/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200910 *
911 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
912 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200913 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200914 *
915 * This enables the following ciphersuites (if other requisites are
916 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
918 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
919 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
921 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
922 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200925
926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200928 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200929 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200930 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
932 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200933 *
934 * This enables the following ciphersuites (if other requisites are
935 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
937 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
938 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
939 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
940 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
941 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
942 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
943 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
944 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
945 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200948
949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200951 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200952 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
955 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200956 *
957 * This enables the following ciphersuites (if other requisites are
958 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
960 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
961 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
962 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
963 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
964 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
965 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
966 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
967 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
968 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
969 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
970 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200971 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200973
974/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200975 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200976 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200977 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200978 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
980 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200981 *
982 * This enables the following ciphersuites (if other requisites are
983 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
985 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
986 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
987 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
988 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
989 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
990 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
991 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
992 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
993 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
994 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
995 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100996 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100997 * \warning Using DHE constitutes a security risk as it
998 * is not possible to validate custom DH parameters.
999 * If possible, it is recommended users should consider
1000 * preferring other methods of key exchange.
1001 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001002 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001008 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001009 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001010 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001011 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1012 * MBEDTLS_RSA_C
1013 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001015 *
1016 * This enables the following ciphersuites (if other requisites are
1017 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1019 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1020 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1021 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1022 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1023 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1024 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1025 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1026 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1027 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001030
1031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001034 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001035 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001036 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1037 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1038 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001039 *
1040 * This enables the following ciphersuites (if other requisites are
1041 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1043 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1044 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1046 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1047 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1049 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1050 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1051 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001054
1055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001057 *
1058 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1059 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001060 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1061 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1062 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001063 *
1064 * This enables the following ciphersuites (if other requisites are
1065 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1067 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1073 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001078
1079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001081 *
1082 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1083 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001084 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1085 * MBEDTLS_RSA_C
1086 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001087 *
1088 * This enables the following ciphersuites (if other requisites are
1089 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1091 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1092 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1093 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1094 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1095 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1096 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1097 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1098 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1099 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001102
1103/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001104 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1105 *
1106 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1107 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001108 * \warning This is currently experimental. EC J-PAKE support is based on the
1109 * Thread v1.0.0 specification; incompatible changes to the specification
1110 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001111 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001112 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001113 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001114 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1115 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001116 * \warning If SHA-256 is provided only by a PSA driver, you must call
1117 * psa_crypto_init() before the first hanshake (even if
1118 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1119 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001120 * This enables the following ciphersuites (if other requisites are
1121 * enabled as well):
1122 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1123 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001124//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001125
1126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001128 *
1129 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1130 * RFC 5915 and RFC 5480.
1131 *
1132 * Currently this means parsing the SpecifiedECDomain choice of EC
1133 * parameters (only known groups are supported, not arbitrary domains, to
1134 * avoid validation issues).
1135 *
1136 * Disable if you only need to support RFC 5915 + 5480 key formats.
1137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001138#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001139
1140/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001141 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1142 *
1143 * Enable the support for parsing public keys of type Short Weierstrass
1144 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001145 * compressed point format. This parsing is done through ECP module's functions.
1146 *
1147 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1148 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1149 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001150 */
1151#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1152
1153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001155 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * Enable a dummy error function to make use of mbedtls_strerror() in
1157 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1158 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1161 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001162 *
1163 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001167
1168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001170 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001171 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001176
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001177/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001179 *
1180 * Enable functions that use the filesystem.
1181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001183
1184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001186 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001187 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001188 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001189 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001190 * application.
1191 *
1192 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001195
1196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001198 *
1199 * Do not use built-in platform entropy functions.
1200 * This is useful if your platform does not support
1201 * standards like the /dev/urandom or Windows CryptoAPI.
1202 *
1203 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001205//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001206
1207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001208 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001209 *
1210 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1211 * default SHA-512 based one (if both are available).
1212 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001214 *
1215 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1216 * if you have performance concerns.
1217 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001218 * This option is only useful if both MBEDTLS_SHA256_C and
1219 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001221//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001222
1223/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001224 * \def MBEDTLS_ENTROPY_NV_SEED
1225 *
1226 * Enable the non-volatile (NV) seed file-based entropy source.
1227 * (Also enables the NV seed read/write functions in the platform layer)
1228 *
1229 * This is crucial (if not required) on systems that do not have a
1230 * cryptographic entropy source (in hardware or kernel) available.
1231 *
1232 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1233 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001234 * \note The read/write functions that are used by the entropy source are
1235 * determined in the platform layer, and can be modified at runtime and/or
1236 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1237 *
1238 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001239 * with regular fopen(), please make sure you make a seedfile with the
1240 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1241 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001242 * and written to or you will get an entropy source error! The default
1243 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1244 * bytes from the file.
1245 *
1246 * \note The entropy collector will write to the seed file before entropy is
1247 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001248 */
1249//#define MBEDTLS_ENTROPY_NV_SEED
1250
Ronald Cron71016a92020-08-28 19:01:50 +02001251/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001252 *
Ronald Cron71016a92020-08-28 19:01:50 +02001253 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001254 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001255 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1256 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001257 *
1258 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001259 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001260 */
Ronald Cron71016a92020-08-28 19:01:50 +02001261//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001262
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001264 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001265 *
1266 * Enable debugging of buffer allocator memory issues. Automatically prints
1267 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1268 * function for 'debug output' of allocated memory.
1269 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001270 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001271 *
1272 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001275
1276/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001277 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001278 *
1279 * Include backtrace information with each allocated block.
1280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001282 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001283 *
1284 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001286//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001287
1288/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001290 *
1291 * Support external private RSA keys (eg from a HSM) in the PK layer.
1292 *
1293 * Comment this macro to disable support for external private RSA keys.
1294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001296
1297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001299 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001300 * Enable support for PKCS#1 v1.5 encoding.
1301 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001302 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001303 *
Paul Bakker48377d92013-08-30 12:06:24 +02001304 * This enables support for PKCS#1 v1.5 operations.
1305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001307
1308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001310 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001311 * Enable support for PKCS#1 v2.1 encoding.
1312 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001313 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001314 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001315 * \warning If using a hash that is only provided by PSA drivers, you must
1316 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001317 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001318 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001320#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001321
Steven Cooreman6801f082021-02-19 17:21:22 +01001322/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1323 *
1324 * Enable support for platform built-in keys. If you enable this feature,
1325 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1326 * See the documentation of that function for more information.
1327 *
1328 * Built-in keys are typically derived from a hardware unique key or
1329 * stored in a secure element.
1330 *
1331 * Requires: MBEDTLS_PSA_CRYPTO_C.
1332 *
1333 * \warning This interface is experimental and may change or be removed
1334 * without notice.
1335 */
1336//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1337
Ronald Cron3768ac12021-01-26 16:58:00 +01001338/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1339 *
1340 * Enable support for PSA crypto client.
1341 *
1342 * \note This option allows to include the code necessary for a PSA
1343 * crypto client when the PSA crypto implementation is not included in
1344 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1345 * code to set and get PSA key attributes.
1346 * The development of PSA drivers partially relying on the library to
1347 * fulfill the hardware gaps is another possible usage of this option.
1348 *
1349 * \warning This interface is experimental and may change or be removed
1350 * without notice.
1351 */
1352//#define MBEDTLS_PSA_CRYPTO_CLIENT
1353
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001354/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1355 *
1356 * Make the PSA Crypto module use an external random generator provided
1357 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1358 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001359 * \note This random generator must deliver random numbers with cryptographic
1360 * quality and high performance. It must supply unpredictable numbers
1361 * with a uniform distribution. The implementation of this function
1362 * is responsible for ensuring that the random generator is seeded
1363 * with sufficient entropy. If you have a hardware TRNG which is slow
1364 * or delivers non-uniform output, declare it as an entropy source
1365 * with mbedtls_entropy_add_source() instead of enabling this option.
1366 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001367 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001368 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1369 * and define a function called mbedtls_psa_external_get_random()
1370 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001371 * ```
1372 * psa_status_t mbedtls_psa_external_get_random(
1373 * mbedtls_psa_external_random_context_t *context,
1374 * uint8_t *output, size_t output_size, size_t *output_length);
1375 * );
1376 * ```
1377 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001378 * The function must fill the \c output buffer with \c output_size bytes
1379 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001380 *
1381 * Requires: MBEDTLS_PSA_CRYPTO_C
1382 *
1383 * \warning If you enable this option, code that uses the PSA cryptography
1384 * interface will not use any of the entropy sources set up for
1385 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1386 * enables.
1387 *
1388 * \note This option is experimental and may be removed without notice.
1389 */
1390//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1391
Paul Bakker9dcc3222011-03-08 14:16:06 +00001392/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001393 * \def MBEDTLS_PSA_CRYPTO_SPM
1394 *
1395 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1396 * Partition Manager) integration which separates the code into two parts: a
1397 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1398 * Environment).
1399 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001400 * If you enable this option, your build environment must include a header
1401 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1402 * header files, or in another directory on the compiler's include search
1403 * path). Alternatively, your platform may customize the header
1404 * `psa/crypto_platform.h`, in which case it can skip or replace the
1405 * inclusion of `"crypto_spe.h"`.
1406 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001407 * Module: library/psa_crypto.c
1408 * Requires: MBEDTLS_PSA_CRYPTO_C
1409 *
1410 */
1411//#define MBEDTLS_PSA_CRYPTO_SPM
1412
1413/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001414 * Uncomment to enable p256-m. This is an alternative implementation of
1415 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1416 * Compared to the default implementation:
1417 *
1418 * - p256-m has a much smaller code size and RAM footprint.
1419 * - p256-m is only available via the PSA API. This includes the pk module
1420 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1421 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1422 * over the core arithmetic, or deterministic derivation of keys.
1423 *
1424 * We recommend enabling this option if your application uses the PSA API
1425 * and the only elliptic curve support it needs is ECDH and ECDSA over
1426 * SECP256R1.
1427 *
1428 * If you enable this option, you do not need to enable any ECC-related
1429 * MBEDTLS_xxx option. You do need to separately request support for the
1430 * cryptographic mechanisms through the PSA API:
1431 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1432 * configuration;
1433 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1434 * - #PSA_WANT_ECC_SECP_R1_256;
1435 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1436 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1437 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1438 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1439 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001440 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001441 * \note To benefit from the smaller code size of p256-m, make sure that you
1442 * do not enable any ECC-related option not supported by p256-m: this
1443 * would cause the built-in ECC implementation to be built as well, in
1444 * order to provide the required option.
1445 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001446 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1447 * SECP256R1 are disabled as they are not supported by this driver.
1448 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1449 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001450 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001451 */
1452//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1453
1454/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001455 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001456 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001457 * Enable support for entropy injection at first boot. This feature is
1458 * required on systems that do not have a built-in entropy source (TRNG).
1459 * This feature is currently not supported on systems that have a built-in
1460 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001461 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001462 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001463 *
1464 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001465//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001466
1467/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001468 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001469 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001470 * Assume all buffers passed to PSA functions are owned exclusively by the
1471 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001472 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001473 * This option may be enabled if all buffers passed to any PSA function reside
1474 * in memory that is accessible only to the PSA function during its execution.
1475 *
1476 * This option MUST be disabled whenever buffer arguments are in memory shared
1477 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001478 * across a trust boundary.
1479 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001480 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001481 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001482 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001483 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001484 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001485//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001486
1487/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001489 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001490 * Do not use the Chinese Remainder Theorem
1491 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001492 *
1493 * Uncomment this macro to disable the use of CRT in RSA.
1494 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001497
1498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001500 *
1501 * Enable the checkup functions (*_self_test).
1502 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001503#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001504
1505/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001506 * \def MBEDTLS_SHA256_SMALLER
1507 *
1508 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1509 * lower performance.
1510 *
Adam Wolf039080f2019-09-10 09:53:08 -05001511 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001512 * performance and size. This version optimizes more aggressively for size at
1513 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1514 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1515 * 30%.
1516 *
1517 * Uncomment to enable the smaller implementation of SHA256.
1518 */
1519//#define MBEDTLS_SHA256_SMALLER
1520
1521/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001522 * \def MBEDTLS_SHA512_SMALLER
1523 *
1524 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1525 * lower performance.
1526 *
1527 * Uncomment to enable the smaller implementation of SHA512.
1528 */
1529//#define MBEDTLS_SHA512_SMALLER
1530
1531/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001533 *
1534 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001535 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001536 * with other servers, only debugging of failures is harder.
1537 *
1538 * The advantage of not sending alert messages, is that no information is given
1539 * about reasons for failures thus preventing adversaries of gaining intel.
1540 *
1541 * Enable sending of all alert messages
1542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001544
1545/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001546 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1547 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001548 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001549 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001550 * in the underlying transport. The CID functionality is described
1551 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001552 *
1553 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001554 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1555 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1556 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001557 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001558 * The maximum lengths of outgoing and incoming CIDs can be configured
1559 * through the options
1560 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1561 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1562 *
1563 * Requires: MBEDTLS_SSL_PROTO_DTLS
1564 *
1565 * Uncomment to enable the Connection ID extension.
1566 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001567#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1568
1569
1570/**
1571 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1572 *
1573 * Defines whether RFC 9146 (default) or the legacy version
1574 * (version draft-ietf-tls-dtls-connection-id-05,
1575 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1576 * is used.
1577 *
1578 * Set the value to 0 for the standard version, and
1579 * 1 for the legacy draft version.
1580 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001581 * \deprecated Support for the legacy version of the DTLS
1582 * Connection ID feature is deprecated. Please
1583 * switch to the standardized version defined
1584 * in RFC 9146 enabled by utilizing
1585 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1586 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1587 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001588 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1589 */
1590#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001591
1592/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001593 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1594 *
1595 * Enable asynchronous external private key operations in SSL. This allows
1596 * you to configure an SSL connection to call an external cryptographic
1597 * module to perform private key operations instead of performing the
1598 * operation inside the library.
1599 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001600 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001601 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001602//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001603
1604/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001605 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1606 *
1607 * Enable serialization of the TLS context structures, through use of the
1608 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1609 *
1610 * This pair of functions allows one side of a connection to serialize the
1611 * context associated with the connection, then free or re-use that context
1612 * while the serialized state is persisted elsewhere, and finally deserialize
1613 * that state to a live context for resuming read/write operations on the
1614 * connection. From a protocol perspective, the state of the connection is
1615 * unaffected, in particular this is entirely transparent to the peer.
1616 *
1617 * Note: this is distinct from TLS session resumption, which is part of the
1618 * protocol and fully visible by the peer. TLS session resumption enables
1619 * establishing new connections associated to a saved session with shorter,
1620 * lighter handshakes, while context serialization is a local optimization in
1621 * handling a single, potentially long-lived connection.
1622 *
1623 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1624 * saved after the handshake to allow for more efficient serialization, so if
1625 * you don't need this feature you'll save RAM by disabling it.
1626 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001627 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1628 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001629 * Comment to disable the context serialization APIs.
1630 */
1631#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1632
1633/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001634 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001635 *
1636 * Enable the debug messages in SSL module for all issues.
1637 * Debug messages have been disabled in some places to prevent timing
1638 * attacks due to (unbalanced) debugging function calls.
1639 *
1640 * If you need all error reporting you should enable this during debugging,
1641 * but remove this for production servers that should log as well.
1642 *
1643 * Uncomment this macro to report all debug messages on errors introducing
1644 * a timing side-channel.
1645 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001648
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001650 *
1651 * Enable support for Encrypt-then-MAC, RFC 7366.
1652 *
1653 * This allows peers that both support it to use a more robust protection for
1654 * ciphersuites using CBC, providing deep resistance against timing attacks
1655 * on the padding or underlying cipher.
1656 *
1657 * This only affects CBC ciphersuites, and is useless if none is defined.
1658 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001659 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001660 *
1661 * Comment this macro to disable support for Encrypt-then-MAC
1662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001664
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001666 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001667 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1668 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001669 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001670 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001671 * attacks, but it is recommended to always use it (even if you disable
1672 * renegotiation), since it actually fixes a more fundamental issue in the
1673 * original SSL/TLS design, and has implications beyond Triple Handshake.
1674 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001675 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001676 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001677 * Comment this macro to disable support for Extended Master Secret.
1678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001680
Paul Bakkerd66f0702013-01-31 16:57:45 +01001681/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001682 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1683 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001684 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001685 * giving access to the peer's certificate after completion of the handshake.
1686 *
1687 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1688 * recommended to disable this option for reduced RAM usage.
1689 *
1690 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1691 * defined, but always returns \c NULL.
1692 *
1693 * \note This option has no influence on the protection against the
1694 * triple handshake attack. Even if it is disabled, Mbed TLS will
1695 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001696 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001697 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001698 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001699 *
1700 * Comment this macro to disable storing the peer's certificate
1701 * after the handshake.
1702 */
1703#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001707 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001708 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001709 *
1710 * The two main uses of renegotiation are (1) refresh keys on long-lived
1711 * connections and (2) client authentication after the initial handshake.
1712 * If you don't need renegotiation, it's probably better to disable it, since
1713 * it has been associated with security issues in the past and is easy to
1714 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001715 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001716 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1717 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001718 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001719 *
1720 * \note Even if this option is disabled, both client and server are aware
1721 * of the Renegotiation Indication Extension (RFC 5746) used to
1722 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1723 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1724 * configuration of this extension).
1725 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001731 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001732 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001733 *
1734 * Comment this macro to disable support for the max_fragment_length extension
1735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001737
1738/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001739 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1740 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001741 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001742 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001743 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1744 *
1745 * Uncomment this macro to enable support for the record_size_limit extension
1746 */
1747//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1748
1749/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001751 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001752 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001753 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001754 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001755 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1756 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001757 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001758 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001759 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001760 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1761 * are only provided by PSA drivers, you must call psa_crypto_init() before
1762 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001763 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001764 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001766#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001767
1768/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001769 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001770 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001771 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001772 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001773 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001774 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001775 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001776 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001777 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001778 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001779 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1780 * directly performed by TLS 1.3 code. As a consequence, you must
1781 * call psa_crypto_init() before the first TLS 1.3 handshake.
1782 *
1783 * \note Cryptographic operations performed indirectly via another module
1784 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1785 * running handshake hash) only use PSA crypto if
1786 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001787 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001788 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001789 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001790#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001791
1792/**
Ronald Cronab65c522021-11-24 10:47:20 +01001793 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1794 *
1795 * Enable TLS 1.3 middlebox compatibility mode.
1796 *
1797 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1798 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1799 * expecting TLS 1.2 traffic.
1800 *
1801 * Turning on the compatibility mode comes at the cost of a few added bytes
1802 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1803 * that don't use it. Therefore, unless transmission bandwidth is critical and
1804 * you know that middlebox compatibility issues won't occur, it is therefore
1805 * recommended to set this option.
1806 *
1807 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001808 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1809 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001810 *
1811 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001812#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001813
1814/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001815 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1816 *
1817 * Enable TLS 1.3 PSK key exchange mode.
1818 *
1819 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1820 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1821 * effect on the build.
1822 *
1823 */
1824#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1825
1826/**
1827 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1828 *
1829 * Enable TLS 1.3 ephemeral key exchange mode.
1830 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001831 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001832 * MBEDTLS_X509_CRT_PARSE_C
1833 * and at least one of:
1834 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1835 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001836 *
1837 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1838 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1839 * effect on the build.
1840 *
1841 */
1842#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1843
1844/**
1845 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1846 *
1847 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1848 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001849 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001850 *
1851 * Comment to disable support for the PSK ephemeral key exchange mode in
1852 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1853 * have any effect on the build.
1854 *
1855 */
1856#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1857
1858/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 * \def MBEDTLS_SSL_EARLY_DATA
1860 *
1861 * Enable support for RFC 8446 TLS 1.3 early data.
1862 *
1863 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1864 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1865 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1866 *
1867 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1868 * is not enabled, this option does not have any effect on the build.
1869 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001870 * \note The maximum amount of early data can be set with
1871 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1872 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001874//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001875
1876/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001878 *
1879 * Enable support for DTLS (all available versions).
1880 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001881 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001882 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001883 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001884 *
1885 * Comment this macro to disable support for DTLS
1886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001888
1889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001891 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001892 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001893 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001894 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001897
1898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001900 *
1901 * Enable support for the anti-replay mechanism in DTLS.
1902 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * Requires: MBEDTLS_SSL_TLS_C
1904 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001905 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001906 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001907 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001908 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001909 * Comment this to disable anti-replay in DTLS.
1910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001912
1913/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001915 *
1916 * Enable support for HelloVerifyRequest on DTLS servers.
1917 *
1918 * This feature is highly recommended to prevent DTLS servers being used as
1919 * amplifiers in DoS attacks against other hosts. It should always be enabled
1920 * unless you know for sure amplification cannot be a problem in the
1921 * environment in which your server operates.
1922 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001923 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001924 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001925 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001926 *
1927 * Comment this to disable support for HelloVerifyRequest.
1928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001930
1931/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001932 * \def MBEDTLS_SSL_DTLS_SRTP
1933 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001934 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001935 * through the use_srtp extension.
1936 *
1937 * \note This feature provides the minimum functionality required
1938 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1939 * the associated SRTP packet protection key material.
1940 * In particular, the SRTP packet protection itself, as well as the
1941 * demultiplexing of RTP and DTLS packets at the datagram layer
1942 * (see Section 5 of RFC 5764), are not handled by this feature.
1943 * Instead, after successful completion of a handshake negotiating
1944 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001945 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001946 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1947 * (this is implemented in the SSL example programs).
1948 * The resulting key should then be passed to an SRTP stack.
1949 *
1950 * Setting this option enables the runtime API
1951 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1952 * through which the supported DTLS-SRTP protection
1953 * profiles can be configured. You must call this API at
1954 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001955 *
1956 * Requires: MBEDTLS_SSL_PROTO_DTLS
1957 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001958 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001959 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001960//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001961
1962/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001963 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1964 *
1965 * Enable server-side support for clients that reconnect from the same port.
1966 *
1967 * Some clients unexpectedly close the connection and try to reconnect using the
1968 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001969 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001970 * flag enables that support.
1971 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001972 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001973 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001974 * Comment this to disable support for clients reusing the source port.
1975 */
1976#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1977
1978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001980 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001981 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001982 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001983 * session store remains the responsibility of the application, though).
1984 * Server-side, you also need to provide callbacks for writing and parsing
1985 * tickets, including authenticated encryption and key management. Example
1986 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001987 *
1988 * Comment this macro to disable support for SSL session tickets
1989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001991
1992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001993 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001994 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001995 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001997 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001998 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001999 * Comment this macro to disable support for server name indication in SSL
2000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002002
2003/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002004 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2005 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002006 * When this option is enabled, the SSL buffer will be resized automatically
2007 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002008 *
2009 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002010 */
2011//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2012
2013/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002014 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2015 *
2016 * Enable testing of the constant-flow nature of some sensitive functions with
2017 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002018 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002019 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002020 * This setting requires compiling with clang -fsanitize=memory. The test
2021 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002022 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002023 * \warning This macro is only used for extended testing; it is not considered
2024 * part of the library's API, so it may change or disappear at any time.
2025 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002026 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002027 */
2028//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2029
2030/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002031 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2032 *
2033 * Enable testing of the constant-flow nature of some sensitive functions with
2034 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002035 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002036 *
2037 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002038 * testing if the tests suites are run with valgrind's memcheck. This can be
2039 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2040 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002041 *
2042 * \warning This macro is only used for extended testing; it is not considered
2043 * part of the library's API, so it may change or disappear at any time.
2044 *
2045 * Uncomment to enable testing of the constant-flow nature of selected code.
2046 */
2047//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2048
2049/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002050 * \def MBEDTLS_TEST_HOOKS
2051 *
2052 * Enable features for invasive testing such as introspection functions and
2053 * hooks for fault injection. This enables additional unit tests.
2054 *
2055 * Merely enabling this feature should not change the behavior of the product.
2056 * It only adds new code, and new branching points where the default behavior
2057 * is the same as when this feature is disabled.
2058 * However, this feature increases the attack surface: there is an added
2059 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2060 * Therefore this feature must never be enabled in production.
2061 *
2062 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2063 * information.
2064 *
2065 * Uncomment to enable invasive tests.
2066 */
2067//#define MBEDTLS_TEST_HOOKS
2068
2069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002071 *
2072 * Provide your own alternate threading implementation.
2073 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002075 *
2076 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002079
2080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002082 *
2083 * Enable the pthread wrapper layer for the threading layer.
2084 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002086 *
2087 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002090
2091/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002092 * \def MBEDTLS_USE_PSA_CRYPTO
2093 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002094 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2095 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002096 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002097 * \note Development of this option is currently in progress, and parts of Mbed
2098 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002099 * will still continue to work as usual, so enabling this option should not
2100 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002101 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002102 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002103 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2104 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002105 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002106 * \note An important and desirable effect of this option is that it allows
2107 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2108 * 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 +02002109 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002110 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2111 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002112 *
2113 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002114 *
2115 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002116 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002117 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002119//#define MBEDTLS_USE_PSA_CRYPTO
2120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002122 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2123 *
John Durkop185764f2020-10-12 21:32:12 -07002124 * This setting allows support for cryptographic mechanisms through the PSA
2125 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002126 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002127 * When this option is disabled, the PSA API exposes the cryptographic
2128 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2129 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002130 *
2131 * When this option is enabled, the PSA API exposes the cryptographic
2132 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2133 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2134 * automatically enabled if required (i.e. if no PSA driver provides the
2135 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2136 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002137 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002138 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002139 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002140 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002141 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2142 * symbols is not completely finalized yet, and the configuration
2143 * tooling is not ideally adapted to having two separate configuration
2144 * files.
2145 * Future minor releases of Mbed TLS may make minor changes to those
2146 * symbols, but we will endeavor to provide a transition path.
2147 * Nonetheless, this option is considered mature enough to use in
2148 * production, as long as you accept that you may need to make
2149 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002150 */
2151//#define MBEDTLS_PSA_CRYPTO_CONFIG
2152
2153/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002154 * \def MBEDTLS_VERSION_FEATURES
2155 *
2156 * Allow run-time checking of compile-time enabled features. Thus allowing users
2157 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002158 * support via mbedtls_version_check_feature().
2159 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002160 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002161 *
2162 * Comment this to disable run-time checking and save ROM space
2163 */
2164#define MBEDTLS_VERSION_FEATURES
2165
2166/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002167 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2168 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002169 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002170 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2171 * the set of trusted certificates through a callback instead of a linked
2172 * list.
2173 *
2174 * This is useful for example in environments where a large number of trusted
2175 * certificates is present and storing them in a linked list isn't efficient
2176 * enough, or when the set of trusted certificates changes frequently.
2177 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002178 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002179 * `mbedtls_ssl_conf_ca_cb()` for more information.
2180 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002181 * Requires: MBEDTLS_X509_CRT_PARSE_C
2182 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002183 * Uncomment to enable trusted certificate callbacks.
2184 */
2185//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2186
2187/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002188 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002189 *
Chris Jones2c745862020-12-16 11:41:06 +00002190 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002191 *
Chris Jones2c745862020-12-16 11:41:06 +00002192 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002193 * and other functions/constants only used by these functions, thus reducing
2194 * the code footprint by several KB.
2195 */
Chris Jones2c745862020-12-16 11:41:06 +00002196//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002197
2198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002200 *
2201 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2202 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2203 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002204 * Requires: MBEDTLS_PKCS1_V21
2205 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002206 * Comment this macro to disallow using RSASSA-PSS in certificates.
2207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002209/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002210
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002211/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002212 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002213 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002214 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002215 * \{
2216 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002217
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002220 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002221 * Enable AES-NI support on x86-64 or x86-32.
2222 *
2223 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002224 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002225 * - GCC, x86-64, target not explicitly supporting AESNI:
2226 * requires MBEDTLS_HAVE_ASM.
2227 * - GCC, x86-32, target not explicitly supporting AESNI:
2228 * not supported.
2229 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2230 * For this assembly-less implementation, you must currently compile
2231 * `library/aesni.c` and `library/aes.c` with machine options to enable
2232 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2233 * `clang -maes -mpclmul`.
2234 * - Non-x86 targets: this option is silently ignored.
2235 * - Other compilers: this option is silently ignored.
2236 *
2237 * \note
2238 * Above, "GCC" includes compatible compilers such as Clang.
2239 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002240 *
2241 * Module: library/aesni.c
2242 * Caller: library/aes.c
2243 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002244 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002245 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002246 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002248#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002249
2250/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002251 * \def MBEDTLS_AESCE_C
2252 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002253 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002254 *
2255 * Module: library/aesce.c
2256 * Caller: library/aes.c
2257 *
Jerry Yuf015a932023-04-25 10:38:03 +08002258 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002259 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002260 * \warning Runtime detection only works on Linux. For non-Linux operating
2261 * system, Armv8-A Cryptographic Extensions must be supported by
2262 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002263 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002264 * \note Minimum compiler versions for this feature when targeting aarch64
2265 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2266 * Minimum compiler versions for this feature when targeting 32-bit
2267 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002268 *
2269 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2270 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002271 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002272 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002273 */
2274#define MBEDTLS_AESCE_C
2275
2276/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002277 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002278 *
2279 * Enable the AES block cipher.
2280 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002281 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002282 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002283 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002284 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002285 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002286 * This module enables the following ciphersuites (if other requisites are
2287 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2289 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2290 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2291 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2292 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2293 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2294 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2295 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2296 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2297 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2298 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2299 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2300 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2301 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2302 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2303 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2304 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2305 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2306 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2307 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2308 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2309 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2310 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2311 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2312 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2313 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2314 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2315 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2316 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2317 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2318 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2319 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2320 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2321 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2322 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2323 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2324 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2325 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2326 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2327 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2328 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2329 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2330 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2331 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2332 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2333 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2334 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2335 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2336 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2337 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2338 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2339 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2340 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2341 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2342 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2343 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2344 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2345 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002346 *
Paul Bakkercff68422013-09-15 20:43:33 +02002347 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002350
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002353 *
2354 * Enable the generic ASN1 parser.
2355 *
2356 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002357 * Caller: library/x509.c
2358 * library/dhm.c
2359 * library/pkcs12.c
2360 * library/pkcs5.c
2361 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002364
2365/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002367 *
2368 * Enable the generic ASN1 writer.
2369 *
2370 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002371 * Caller: library/ecdsa.c
2372 * library/pkwrite.c
2373 * library/x509_create.c
2374 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002375 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002378
2379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002381 *
2382 * Enable the Base64 module.
2383 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002384 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002385 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002387 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002390
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002391/**
Yanray Wange367e472023-10-31 17:23:04 +08002392 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2393 *
2394 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2395 *
2396 * \note This feature is incompatible with insecure block cipher,
2397 * MBEDTLS_DES_C, and cipher modes which always require decryption
2398 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002399 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2400 * this feature is incompatible with following supported PSA equivalence,
2401 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2402 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002403 *
2404 * Module: library/aes.c
2405 * library/aesce.c
2406 * library/aesni.c
2407 * library/aria.c
2408 * library/camellia.c
2409 * library/cipher.c
2410 */
2411//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2412
2413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002415 *
Paul Bakker9a736322012-11-14 12:39:52 +00002416 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002417 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002418 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002419 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002420 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002421 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002422 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002423 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002424 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002425 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002426 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002428 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002429 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002432
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002435 *
2436 * Enable the Camellia block cipher.
2437 *
Paul Bakker38119b12009-01-10 23:31:23 +00002438 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002439 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002440 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002441 * This module enables the following ciphersuites (if other requisites are
2442 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2444 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2445 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2446 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2447 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2448 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2449 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2450 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2451 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2452 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2454 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2455 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2456 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2457 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2458 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2459 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2460 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2461 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2462 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2463 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2464 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2465 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2466 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2467 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2468 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2469 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2470 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2471 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2472 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2473 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2474 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2475 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2476 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2477 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2478 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2479 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2480 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2481 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2482 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2483 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2484 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002487
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002489 * \def MBEDTLS_ARIA_C
2490 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002491 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002492 *
2493 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002494 * Caller: library/cipher.c
2495 *
2496 * This module enables the following ciphersuites (if other requisites are
2497 * enabled as well):
2498 *
2499 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2500 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2501 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2502 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2503 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2504 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2505 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2506 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2507 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2508 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2509 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2510 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2511 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2512 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2513 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2514 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2516 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2517 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2518 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2519 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2520 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2521 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2522 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2523 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2524 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2525 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2526 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2527 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2528 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2529 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2530 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2531 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2532 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2533 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2534 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2535 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2536 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002537 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002538#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002539
2540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002542 *
2543 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2544 *
2545 * Module: library/ccm.c
2546 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002547 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2548 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002549 *
2550 * This module enables the AES-CCM ciphersuites, if other requisites are
2551 * enabled as well.
2552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002553#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002554
2555/**
Daniel King34b822c2016-05-15 17:28:08 -03002556 * \def MBEDTLS_CHACHA20_C
2557 *
2558 * Enable the ChaCha20 stream cipher.
2559 *
2560 * Module: library/chacha20.c
2561 */
2562#define MBEDTLS_CHACHA20_C
2563
2564/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002565 * \def MBEDTLS_CHACHAPOLY_C
2566 *
2567 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2568 *
2569 * Module: library/chachapoly.c
2570 *
2571 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2572 */
2573#define MBEDTLS_CHACHAPOLY_C
2574
2575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002577 *
2578 * Enable the generic cipher layer.
2579 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002580 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002581 * Caller: library/ccm.c
2582 * library/cmac.c
2583 * library/gcm.c
2584 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002585 * library/pkcs12.c
2586 * library/pkcs5.c
2587 * library/psa_crypto_aead.c
2588 * library/psa_crypto_mac.c
2589 * library/ssl_ciphersuites.c
2590 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002591 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002592 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2593 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002594 *
2595 * Uncomment to enable generic cipher wrappers.
2596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002597#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002598
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002599/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002600 * \def MBEDTLS_CMAC_C
2601 *
Simon Butcher327398a2016-10-05 14:09:11 +01002602 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2603 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002604 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002605 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2606 * implementation of the CMAC algorithm is provided by an alternate
2607 * implementation, that alternate implementation may opt to not support
2608 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2609 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002610 * Module: library/cmac.c
2611 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002612 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002613 *
2614 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002615#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002616
2617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002619 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002620 * Enable the CTR_DRBG AES-based random generator.
2621 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002622 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002623 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002624 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2625 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2626 * is used.
2627 *
2628 * \warning When using PSA, the user should call `psa_crypto_init()` before
2629 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2630 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002631 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2632 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002633 * \note To achieve a 256-bit security strength with CTR_DRBG,
2634 * you must use AES-256 *and* use sufficient entropy.
2635 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002636 *
2637 * Module: library/ctr_drbg.c
2638 * Caller:
2639 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002640 * Requires: MBEDTLS_AES_C or
2641 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2642 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002643 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002644 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002647
2648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002650 *
2651 * Enable the debug functions.
2652 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002653 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002654 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002655 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002656 * library/ssl_tls12_*.c
2657 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002658 *
2659 * This module provides debugging functions.
2660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002662
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002663/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002665 *
2666 * Enable the DES block cipher.
2667 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002668 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002669 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002670 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002671 *
Paul Bakkercff68422013-09-15 20:43:33 +02002672 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002673 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002674 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002675 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002676 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002678
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002679/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002681 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002682 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002683 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002684 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002685 * Caller: library/ssl_tls.c
2686 * library/ssl*_client.c
2687 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002688 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002689 * This module is used by the following key exchanges:
2690 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002691 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002692 * \warning Using DHE constitutes a security risk as it
2693 * is not possible to validate custom DH parameters.
2694 * If possible, it is recommended users should consider
2695 * preferring other methods of key exchange.
2696 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002697 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002700
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002703 *
2704 * Enable the elliptic curve Diffie-Hellman library.
2705 *
2706 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002707 * Caller: library/psa_crypto.c
2708 * library/ssl_tls.c
2709 * library/ssl*_client.c
2710 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002711 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002712 * This module is used by the following key exchanges:
2713 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002714 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002716 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002718
2719/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002721 *
2722 * Enable the elliptic curve DSA library.
2723 *
2724 * Module: library/ecdsa.c
2725 * Caller:
2726 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002727 * This module is used by the following key exchanges:
2728 * ECDHE-ECDSA
2729 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002730 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2731 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2732 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002735
2736/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002737 * \def MBEDTLS_ECJPAKE_C
2738 *
2739 * Enable the elliptic curve J-PAKE library.
2740 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002741 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2742 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002743 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002744 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002745 * Module: library/ecjpake.c
2746 * Caller:
2747 *
2748 * This module is used by the following key exchanges:
2749 * ECJPAKE
2750 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002751 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002752 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002753 * \warning If using a hash that is only provided by PSA drivers, you must
2754 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002755 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002756#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002757
2758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002760 *
2761 * Enable the elliptic curve over GF(p) library.
2762 *
2763 * Module: library/ecp.c
2764 * Caller: library/ecdh.c
2765 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002766 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002767 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002771
2772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002774 *
2775 * Enable the platform-specific entropy code.
2776 *
2777 * Module: library/entropy.c
2778 * Caller:
2779 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002781 *
2782 * This module provides a generic entropy pool
2783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002785
2786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002788 *
2789 * Enable error code to error string conversion.
2790 *
2791 * Module: library/error.c
2792 * Caller:
2793 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002797
2798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002800 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002801 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002802 *
2803 * Module: library/gcm.c
2804 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002805 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2806 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002807 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002808 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2809 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002812
2813/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002814 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002815 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002816 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002817 * Can significantly increase throughput on systems without GCM hardware
2818 * acceleration (e.g., AESNI, AESCE).
2819 *
Matthias Schulz78266782024-02-08 13:54:48 +01002820 * The mbedtls_gcm_context size will increase by 3840 bytes.
2821 * The code size will increase by roughly 344 bytes.
2822 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002823 * Module: library/gcm.c
2824 *
2825 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002826 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002827//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002828
2829/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002830 * \def MBEDTLS_HKDF_C
2831 *
2832 * Enable the HKDF algorithm (RFC 5869).
2833 *
2834 * Module: library/hkdf.c
2835 * Caller:
2836 *
2837 * Requires: MBEDTLS_MD_C
2838 *
2839 * This module adds support for the Hashed Message Authentication Code
2840 * (HMAC)-based key derivation function (HKDF).
2841 */
2842#define MBEDTLS_HKDF_C
2843
2844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002846 *
2847 * Enable the HMAC_DRBG random generator.
2848 *
2849 * Module: library/hmac_drbg.c
2850 * Caller:
2851 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002853 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002854 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002857
2858/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002859 * \def MBEDTLS_LMS_C
2860 *
2861 * Enable the LMS stateful-hash asymmetric signature algorithm.
2862 *
2863 * Module: library/lms.c
2864 * Caller:
2865 *
Raef Colesab4f8742022-09-01 12:24:31 +01002866 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002867 *
Raef Colesab4f8742022-09-01 12:24:31 +01002868 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002869 */
2870#define MBEDTLS_LMS_C
2871
2872/**
Raef Colesab4f8742022-09-01 12:24:31 +01002873 * \def MBEDTLS_LMS_PRIVATE
2874 *
2875 * Enable LMS private-key operations and signing code. Functions enabled by this
2876 * option are experimental, and should not be used in production.
2877 *
2878 * Requires: MBEDTLS_LMS_C
2879 *
2880 * Uncomment to enable the LMS signature algorithm and private key operations.
2881 */
Raef Coles5127e852022-10-07 10:35:56 +01002882//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002883
2884/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002885 * \def MBEDTLS_NIST_KW_C
2886 *
2887 * Enable the Key Wrapping mode for 128-bit block ciphers,
2888 * as defined in NIST SP 800-38F. Only KW and KWP modes
2889 * are supported. At the moment, only AES is approved by NIST.
2890 *
2891 * Module: library/nist_kw.c
2892 *
2893 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2894 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002895#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002896
2897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002899 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002900 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002901 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002902 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2903 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002904 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002905 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002906 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002907 * Caller: library/constant_time.c
2908 * library/ecdsa.c
2909 * library/ecjpake.c
2910 * library/hkdf.c
2911 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002912 * library/pk.c
2913 * library/pkcs5.c
2914 * library/pkcs12.c
2915 * library/psa_crypto_ecp.c
2916 * library/psa_crypto_rsa.c
2917 * library/rsa.c
2918 * library/ssl_cookie.c
2919 * library/ssl_msg.c
2920 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002921 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002922 * library/x509_crt.c
2923 * library/x509write_crt.c
2924 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002925 *
2926 * Uncomment to enable generic message digest wrappers.
2927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002928#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002929
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002930/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002932 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002933 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002934 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002935 * Module: library/md5.c
2936 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002937 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002938 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002939 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002940 * This module is required for TLS 1.2 depending on the handshake parameters.
2941 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2942 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002943 *
2944 * \warning MD5 is considered a weak message digest and its use constitutes a
2945 * security risk. If possible, we recommend avoiding dependencies on
2946 * it, and considering stronger message digests instead.
2947 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002949#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002950
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002953 *
2954 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002955 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002956 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002957 *
2958 * Module: library/memory_buffer_alloc.c
2959 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002961 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002962 *
2963 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002964 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002966
2967/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002968 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002969 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002970 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2971 *
Simon Butcherd567a232016-03-09 20:19:21 +00002972 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2973 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002974 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002975 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002976 * \note See also our Knowledge Base article about porting to a new
2977 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002978 * 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 +00002979 *
Andres AG788aa4a2016-09-14 14:32:09 +01002980 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002981 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002982 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002985
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002988 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002989 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002990 *
2991 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002992 * Caller: library/asn1write.c
2993 * library/pkcs5.c
2994 * library/pkparse.c
2995 * library/pkwrite.c
2996 * library/rsa.c
2997 * library/x509.c
2998 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002999 * library/x509_crl.c
3000 * library/x509_crt.c
3001 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003002 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003003 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003004 *
3005 * This modules translates between OIDs and internal values.
3006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003008
3009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003011 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003012 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003013 *
3014 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003015 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003016 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003017 * library/x509_crl.c
3018 * library/x509_crt.c
3019 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003020 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003021 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01003022 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
3023 *
3024 * \warning When parsing password-protected files, if MD5 is provided only by
3025 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00003026 *
Paul Bakkercff68422013-09-15 20:43:33 +02003027 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003030
3031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003034 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003035 *
3036 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003037 * Caller: library/pkwrite.c
3038 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003039 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003040 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003042 *
3043 * This modules adds support for encoding / writing PEM files.
3044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003046
3047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003049 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003050 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003051 *
3052 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003053 * Caller: library/psa_crypto_rsa.c
3054 * library/ssl_tls.c
3055 * library/ssl*_client.c
3056 * library/ssl*_server.c
3057 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003058 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003059 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003060 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003061 * Uncomment to enable generic public key wrappers.
3062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003064
3065/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003067 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003068 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003069 *
3070 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003071 * Caller: library/x509_crt.c
3072 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003073 *
Yanray Wang072a0682023-12-05 10:53:04 +08003074 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003075 *
3076 * Uncomment to enable generic public key parse functions.
3077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003079
3080/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003081 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003082 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003083 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003084 *
3085 * Module: library/pkwrite.c
3086 * Caller: library/x509write.c
3087 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003088 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003089 *
3090 * Uncomment to enable generic public key write functions.
3091 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003092#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003093
3094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003096 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003097 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003098 *
3099 * Module: library/pkcs5.c
3100 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003101 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003102 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003103 * \warning If using a hash that is only provided by PSA drivers, you must
3104 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003105 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003106 * This module adds support for the PKCS#5 functions.
3107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003109
3110/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003111 * \def MBEDTLS_PKCS7_C
3112 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003113 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003114 * RFC Link - https://tools.ietf.org/html/rfc2315
3115 *
3116 * Module: library/pkcs7.c
3117 *
3118 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003119 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3120 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003121 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003122 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003123 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003124#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003125
3126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003128 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003129 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003130 * Adds algorithms for parsing PKCS#8 encrypted private keys
3131 *
3132 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003133 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003134 *
Valerio Settie98ad592023-12-28 10:42:12 +01003135 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3136 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003137 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003138 * \warning If using a hash that is only provided by PSA drivers, you must
3139 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003140 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003141 * This module enables PKCS#12 functions.
3142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003144
3145/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003147 *
3148 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003149 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003150 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3152 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003153 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003154 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003155 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003156 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003157 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003158 * Module: library/platform.c
3159 * Caller: Most other .c files
3160 *
3161 * This module enables abstraction of common (libc) functions.
3162 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003163#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003164
3165/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003166 * \def MBEDTLS_POLY1305_C
3167 *
3168 * Enable the Poly1305 MAC algorithm.
3169 *
3170 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003171 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003172 */
3173#define MBEDTLS_POLY1305_C
3174
3175/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003176 * \def MBEDTLS_PSA_CRYPTO_C
3177 *
3178 * Enable the Platform Security Architecture cryptography API.
3179 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003180 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003181 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003182 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003183 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003184 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3185 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3186 * is enabled in PSA (unless it's fully accelerated, see
3187 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003188 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003189#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003190
3191/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003192 * \def MBEDTLS_PSA_CRYPTO_SE_C
3193 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003194 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003195 * cryptography API.
3196 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003197 * \deprecated This feature is deprecated. Please switch to the PSA driver
3198 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003199 *
Ryan Everett32a64582024-03-05 18:16:18 +00003200 * \warning This feature is not thread-safe, and should not be used in a
3201 * multi-threaded environment.
3202 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003203 * Module: library/psa_crypto_se.c
3204 *
3205 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3206 *
3207 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003208//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003209
3210/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003211 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3212 *
3213 * Enable the Platform Security Architecture persistent key storage.
3214 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003215 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003216 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003217 * Requires: MBEDTLS_PSA_CRYPTO_C,
3218 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3219 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003220 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003221#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003222
3223/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003224 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003225 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003226 * Enable the emulation of the Platform Security Architecture
3227 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003228 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003229 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003230 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003231 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003232 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003233#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003234
3235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003237 *
3238 * Enable the RIPEMD-160 hash algorithm.
3239 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003240 * Module: library/ripemd160.c
3241 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003242 *
3243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003245
3246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003248 *
3249 * Enable the RSA public-key cryptosystem.
3250 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003252 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003253 * Caller: library/pk.c
3254 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003255 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003256 * library/ssl*_client.c
3257 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003258 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003259 * This module is used by the following key exchanges:
3260 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003261 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003265
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003266/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003268 *
3269 * Enable the SHA1 cryptographic hash algorithm.
3270 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003271 * Module: library/sha1.c
3272 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003273 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003274 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003275 * This module is required for TLS 1.2 depending on the handshake parameters,
3276 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003277 *
3278 * \warning SHA-1 is considered a weak message digest and its use constitutes
3279 * a security risk. If possible, we recommend avoiding dependencies
3280 * on it, and considering stronger message digests instead.
3281 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003283#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003284
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003285/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003286 * \def MBEDTLS_SHA224_C
3287 *
3288 * Enable the SHA-224 cryptographic hash algorithm.
3289 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003290 * Module: library/sha256.c
3291 * Caller: library/md.c
3292 * library/ssl_cookie.c
3293 *
3294 * This module adds support for SHA-224.
3295 */
3296#define MBEDTLS_SHA224_C
3297
3298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003300 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003301 * Enable the SHA-256 cryptographic hash algorithm.
3302 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003303 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003304 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003305 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003306 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003307 * library/ssl*_client.c
3308 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003309 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003310 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003311 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003314
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003315/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003316 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003317 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003318 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3319 * with the ARMv8 cryptographic extensions if they are available at runtime.
3320 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003321 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003322 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003323 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003324 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003325 * \note Minimum compiler versions for this feature are Clang 4.0,
3326 * armclang 6.6 or GCC 6.0.
3327 *
3328 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3329 * armclang <= 6.9
3330 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003331 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3332 * That name is deprecated, but may still be used as an alternative form for this
3333 * option.
3334 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003335 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3336 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003337 *
3338 * Requires: MBEDTLS_SHA256_C.
3339 *
3340 * Module: library/sha256.c
3341 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003342 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003343 * and use them if available.
3344 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003345//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003346
Dave Rodgmand85277c2023-10-13 09:22:54 +01003347/**
3348 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3349 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003350 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003351 * This name is now deprecated, but may still be used as an alternative form for
3352 * this option.
3353 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003354//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3355
3356/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003357 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003358 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003359 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3360 * with the ARMv8 cryptographic extensions, which must be available at runtime
3361 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003362 *
3363 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003364 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003365 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003366 * \note Minimum compiler versions for this feature are Clang 4.0,
3367 * armclang 6.6 or GCC 6.0.
3368 *
3369 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3370 * armclang <= 6.9
3371 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003372 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003373 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003374 * option.
3375 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003376 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3377 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003378 *
3379 * Requires: MBEDTLS_SHA256_C.
3380 *
3381 * Module: library/sha256.c
3382 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003383 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003384 * unconditionally.
3385 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003386//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003387
Dave Rodgmand85277c2023-10-13 09:22:54 +01003388/**
3389 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3390 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003391 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003392 * This name is now deprecated, but may still be used as an alternative form for
3393 * this option.
3394 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003395//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3396
3397/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003398 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003399 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003400 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003401 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003402 * Module: library/sha512.c
3403 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003404 * library/psa_crypto_hash.c
3405 * library/ssl_tls.c
3406 * library/ssl*_client.c
3407 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003408 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003409 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003410 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003411#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003412
3413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003415 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003416 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003417 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003418 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003419 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003420 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003421 * library/ssl_tls.c
3422 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003423 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003424 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003427
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003428/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003429 * \def MBEDTLS_SHA3_C
3430 *
3431 * Enable the SHA3 cryptographic hash algorithm.
3432 *
3433 * Module: library/sha3.c
3434 *
3435 * This module adds support for SHA3.
3436 */
3437#define MBEDTLS_SHA3_C
3438
3439/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003440 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3441 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003442 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3443 * with the ARMv8 cryptographic extensions if they are available at runtime.
3444 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003445 *
3446 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3447 * for a non-Aarch64 build it will be silently ignored.
3448 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003449 * \note Minimum compiler versions for this feature are Clang 7.0,
3450 * armclang 6.9 or GCC 8.0.
3451 *
3452 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3453 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003454 *
3455 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3456 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3457 *
3458 * Requires: MBEDTLS_SHA512_C.
3459 *
3460 * Module: library/sha512.c
3461 *
3462 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3463 * and use them if available.
3464 */
3465//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3466
3467/**
3468 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3469 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003470 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3471 * with the ARMv8 cryptographic extensions, which must be available at runtime
3472 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003473 *
3474 * \note This allows builds with a smaller code size than with
3475 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3476 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003477 * \note Minimum compiler versions for this feature are Clang 7.0,
3478 * armclang 6.9 or GCC 8.0.
3479 *
3480 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3481 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003482 *
3483 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3484 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3485 *
3486 * Requires: MBEDTLS_SHA512_C.
3487 *
3488 * Module: library/sha512.c
3489 *
3490 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3491 * unconditionally.
3492 */
3493//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3494
3495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003496 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003497 *
3498 * Enable simple SSL cache implementation.
3499 *
3500 * Module: library/ssl_cache.c
3501 * Caller:
3502 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003506
3507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003509 *
3510 * Enable basic implementation of DTLS cookies for hello verification.
3511 *
3512 * Module: library/ssl_cookie.c
3513 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003515#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003516
3517/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003518 * \def MBEDTLS_SSL_TICKET_C
3519 *
3520 * Enable an implementation of TLS server-side callbacks for session tickets.
3521 *
3522 * Module: library/ssl_ticket.c
3523 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003524 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003525 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3526 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003527 */
3528#define MBEDTLS_SSL_TICKET_C
3529
3530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003531 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003532 *
3533 * Enable the SSL/TLS client code.
3534 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003535 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003536 * Caller:
3537 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003539 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003540 * This module is required for SSL/TLS client support.
3541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003543
Paul Bakker9a736322012-11-14 12:39:52 +00003544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003546 *
3547 * Enable the SSL/TLS server code.
3548 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003549 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003550 * Caller:
3551 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003553 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003554 * This module is required for SSL/TLS server support.
3555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003557
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003559 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003560 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003561 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003562 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003563 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003564 * Caller: library/ssl*_client.c
3565 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3568 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003569 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003570 * This module is required for SSL/TLS.
3571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003573
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003576 *
3577 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003578 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003579 * contexts are not shared between threads. If you do intend to use contexts
3580 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003581 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003582 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003583 *
3584 * Module: library/threading.c
3585 *
3586 * This allows different threading implementations (self-implemented or
3587 * provided).
3588 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * You will have to enable either MBEDTLS_THREADING_ALT or
3590 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003591 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003592 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003594//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003595
3596/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003598 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003599 * Enable the semi-portable timing interface.
3600 *
Simon Butcherd567a232016-03-09 20:19:21 +00003601 * \note The provided implementation only works on POSIX/Unix (including Linux,
3602 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003603 * module and provide your own implementations of the callbacks needed by
3604 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3605 * your own implementation of the whole module by setting
3606 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003607 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003608 * \note The timing module will include time.h on suitable platforms
3609 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3610 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3611 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003612 * \note See also our Knowledge Base article about porting to a new
3613 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003614 * 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 +00003615 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003616 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003619
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003622 *
3623 * Enable run-time version information.
3624 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003625 * Module: library/version.c
3626 *
3627 * This module provides run-time version information.
3628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003630
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003633 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003634 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003635 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003636 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003637 * Caller: library/x509_crl.c
3638 * library/x509_crt.c
3639 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003640 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003641 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003642 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3643 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003644 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3645 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003646 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003647 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003650
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003652 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003653 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003654 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003655 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003656 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003657 * Caller: library/ssl_tls.c
3658 * library/ssl*_client.c
3659 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003660 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003661 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003662 *
3663 * This module is required for X.509 certificate parsing.
3664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003665#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003666
3667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003669 *
3670 * Enable X.509 CRL parsing.
3671 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003672 * Module: library/x509_crl.c
3673 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003674 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003675 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003676 *
3677 * This module is required for X.509 CRL parsing.
3678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003680
3681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003682 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003683 *
3684 * Enable X.509 Certificate Signing Request (CSR) parsing.
3685 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003686 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003687 * Caller: library/x509_crt_write.c
3688 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003690 *
3691 * This module is used for reading X.509 certificate request.
3692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003693#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003694
3695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003696 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003697 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003698 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003699 *
3700 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003701 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003702 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003703 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3704 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003705 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3706 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003707 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003708 * This module is the basis for creating X.509 certificates and CSRs.
3709 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003710#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003711
3712/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003713 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003714 *
3715 * Enable creating X.509 certificates.
3716 *
3717 * Module: library/x509_crt_write.c
3718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003719 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003720 *
3721 * This module is required for X.509 certificate creation.
3722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003723#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003724
3725/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003727 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003728 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003729 *
3730 * Module: library/x509_csr_write.c
3731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003732 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003733 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003734 * This module is required for X.509 certificate request writing.
3735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003737
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003738/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003739
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003740/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003741 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003742 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003743 * This section contains Mbed TLS build settings that are not associated
3744 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003745 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003746 * \{
3747 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003748
Gilles Peskinea02c1242022-03-16 17:03:19 +01003749/**
3750 * \def MBEDTLS_CONFIG_FILE
3751 *
3752 * If defined, this is a header which will be included instead of
3753 * `"mbedtls/mbedtls_config.h"`.
3754 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003755 * Unlike other configuration options, this one must be defined on the
3756 * compiler command line: a definition in `mbedtls_config.h` would have
3757 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003758 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003759 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003760 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003761 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003762 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003763 * The value of this symbol is typically a path in double quotes, either
3764 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003765 */
3766//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3767
3768/**
3769 * \def MBEDTLS_USER_CONFIG_FILE
3770 *
3771 * If defined, this is a header which will be included after
3772 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003773 * This allows you to modify the default configuration, including the ability
3774 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003775 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003776 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003777 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003778 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003779 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003780 * The value of this symbol is typically a path in double quotes, either
3781 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003782 */
3783//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3784
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003785/**
3786 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3787 *
3788 * If defined, this is a header which will be included instead of
3789 * `"psa/crypto_config.h"`.
3790 * This header file specifies which cryptographic mechanisms are available
3791 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3792 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3793 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003794 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003795 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003796 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003797 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003798 * The value of this symbol is typically a path in double quotes, either
3799 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003800 */
3801//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3802
3803/**
3804 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3805 *
3806 * If defined, this is a header which will be included after
3807 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003808 * This allows you to modify the default configuration, including the ability
3809 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003810 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003811 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003812 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003813 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003814 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003815 * The value of this symbol is typically a path in double quotes, either
3816 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003817 */
3818//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3819
Gilles Peskineb1176f22023-02-22 22:07:28 +01003820/**
3821 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3822 *
3823 * If defined, this is a header which will be included instead of
3824 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3825 * as the one in Mbed TLS, but with definitions adapted to the platform on
3826 * which the library code will run.
3827 *
3828 * \note The required content of this header can vary from one version of
3829 * Mbed TLS to the next. Integrators who provide an alternative file
3830 * should review the changes in the original file whenever they
3831 * upgrade Mbed TLS.
3832 *
3833 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3834 * non-standard feature of the C language, so this feature is only available
3835 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3836 *
3837 * The value of this symbol is typically a path in double quotes, either
3838 * absolute or relative to a directory on the include search path.
3839 */
3840//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3841
3842/**
3843 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3844 *
3845 * If defined, this is a header which will be included instead of
3846 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3847 * as the one in Mbed TLS, but with definitions adapted to the environment
3848 * in which the library code will run. The typical use for this feature
3849 * is to provide alternative type definitions on the client side in
3850 * client-server integrations of PSA crypto, where operation structures
3851 * contain handles instead of cryptographic data.
3852 *
3853 * \note The required content of this header can vary from one version of
3854 * Mbed TLS to the next. Integrators who provide an alternative file
3855 * should review the changes in the original file whenever they
3856 * upgrade Mbed TLS.
3857 *
3858 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3859 * non-standard feature of the C language, so this feature is only available
3860 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3861 *
3862 * The value of this symbol is typically a path in double quotes, either
3863 * absolute or relative to a directory on the include search path.
3864 */
3865//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3866
Gilles Peskineba4162a2022-04-11 17:04:38 +02003867/** \} name SECTION: General configuration options */
3868
3869/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003870 * \name SECTION: Module configuration options
3871 *
3872 * This section allows for the setting of module specific sizes and
3873 * configuration options. The default values are already present in the
3874 * relevant header files and should suffice for the regular use cases.
3875 *
3876 * Our advice is to enable options and change their values here
3877 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003878 * \{
3879 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003880/* The Doxygen documentation here is used when a user comments out a
3881 * setting and runs doxygen themselves. On the other hand, when we typeset
3882 * the full documentation including disabled settings, the documentation
3883 * in specific modules' header files is used if present. When editing this
3884 * file, make sure that each option is documented in exactly one place,
3885 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3886 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003887
Paul Bakker088c5c52014-04-25 11:11:10 +02003888/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003889//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003890//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003891
Paul Bakker088c5c52014-04-25 11:11:10 +02003892/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003893//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3894//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3895//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3896//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3897//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003898
Paul Bakker088c5c52014-04-25 11:11:10 +02003899/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003900//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3901//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3902//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3903//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003904
Paul Bakker088c5c52014-04-25 11:11:10 +02003905/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003906//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003907//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003908
Paul Bakker088c5c52014-04-25 11:11:10 +02003909/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003910//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3911//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003912//#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 +01003913
Paul Bakker088c5c52014-04-25 11:11:10 +02003914/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003915//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003916
Paul Bakker088c5c52014-04-25 11:11:10 +02003917/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003918//#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 -04003919
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003920/** \def MBEDTLS_PLATFORM_STD_CALLOC
3921 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003922 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003923 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003924 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003925 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003926 * 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 -04003927 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3928 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003929 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003930 */
3931//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003932
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003933/** \def MBEDTLS_PLATFORM_STD_FREE
3934 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003935 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003936 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003937 * 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 -04003938 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3939 * 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 -04003940 */
3941//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003942//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003944//#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 +02003945//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3946//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003947/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003949//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3950//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003951//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3952//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3953//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003954
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003955/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003956/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003957//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3958//#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 +02003959//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003960//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003961//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3962//#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 +02003963//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3964//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003965/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003966//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003967//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003968//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3969//#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 +08003970//#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 +08003971//#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 +02003972
Gilles Peskine3f106f72021-09-23 17:42:39 +02003973/** \def MBEDTLS_CHECK_RETURN
3974 *
3975 * This macro is used at the beginning of the declaration of a function
3976 * to indicate that its return value should be checked. It should
3977 * instruct the compiler to emit a warning or an error if the function
3978 * is called without checking its return value.
3979 *
3980 * There is a default implementation for popular compilers in platform_util.h.
3981 * You can override the default implementation by defining your own here.
3982 *
3983 * If the implementation here is empty, this will effectively disable the
3984 * checking of functions' return values.
3985 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003986//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003987
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003988/** \def MBEDTLS_IGNORE_RETURN
3989 *
3990 * This macro requires one argument, which should be a C function call.
3991 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3992 * warning is suppressed.
3993 */
3994//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3995
Gilles Peskineed038902020-11-13 21:33:21 +01003996/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003997/**
Gilles Peskineed038902020-11-13 21:33:21 +01003998 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3999 * PSA crypto subsystem.
4000 *
4001 * If this option is unset:
4002 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01004003 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01004004 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
4005 * on unspecified heuristics.
4006 */
4007//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
4008
Steven Cooreman863470a2021-02-15 14:03:19 +01004009/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004010 * Restrict the PSA library to supporting a maximum amount of simultaneously
4011 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
4012 * volatile key, or a persistent key which is loaded temporarily by the
4013 * library as part of a crypto operation in flight.
4014 *
4015 * If this option is unset, the library will fall back to a default value of
4016 * 32 keys.
4017 */
Steven Cooreman863470a2021-02-15 14:03:19 +01004018//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004019
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00004020/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02004021//#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 +00004022
Paul Bakker088c5c52014-04-25 11:11:10 +02004023/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004024//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
4025//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004026
Paul Bakker088c5c52014-04-25 11:11:10 +02004027/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10004028
Angus Grattond8213d02016-05-25 20:56:48 +10004029/** \def MBEDTLS_SSL_IN_CONTENT_LEN
4030 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004031 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004032 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004033 * This determines the size of the incoming TLS I/O buffer in such a way
4034 * that it is capable of holding the specified amount of plaintext data,
4035 * regardless of the protection mechanism used.
4036 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004037 * \note When using a value less than the default of 16KB on the client, it is
4038 * recommended to use the Maximum Fragment Length (MFL) extension to
4039 * inform the server about this limitation. On the server, there
4040 * is no supported, standardized way of informing the client about
4041 * restriction on the maximum size of incoming messages, and unless
4042 * the limitation has been communicated by other means, it is recommended
4043 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4044 * while keeping the default value of 16KB for the incoming buffer.
4045 *
David Horstmann95d516f2021-05-04 18:36:56 +01004046 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004047 */
4048//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4049
Gilles Peskined3d02902020-03-04 21:35:27 +01004050/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4051 *
4052 * The maximum length of CIDs used for incoming DTLS messages.
4053 *
4054 */
4055//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4056
4057/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4058 *
4059 * The maximum length of CIDs used for outgoing DTLS messages.
4060 *
4061 */
4062//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4063
TRodziewicze8dd7092021-05-12 14:19:11 +02004064/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01004065 *
4066 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02004067 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01004068 *
4069 * The padding will always be chosen so that the length of the
4070 * padded plaintext is a multiple of the value of this option.
4071 *
4072 * Note: A value of \c 1 means that no padding will be used
4073 * for outgoing records.
4074 *
4075 * Note: On systems lacking division instructions,
4076 * a power of two should be preferred.
4077 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004078//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004079
Angus Grattond8213d02016-05-25 20:56:48 +10004080/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4081 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004082 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004083 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004084 * This determines the size of the outgoing TLS I/O buffer in such a way
4085 * that it is capable of holding the specified amount of plaintext data,
4086 * regardless of the protection mechanism used.
4087 *
Angus Grattond8213d02016-05-25 20:56:48 +10004088 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4089 * the default inward 16384 byte buffer to conform to the TLS specification.
4090 *
4091 * The minimum required outward buffer size is determined by the handshake
4092 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4093 * The specific size requirement depends on the configured ciphers and any
4094 * certificate data which is sent during the handshake.
4095 *
David Horstmann95d516f2021-05-04 18:36:56 +01004096 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004097 */
4098//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4099
Hanno Beckere0b150f2018-08-21 15:51:03 +01004100/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4101 *
4102 * Maximum number of heap-allocated bytes for the purpose of
4103 * DTLS handshake message reassembly and future message buffering.
4104 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004105 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004106 * to account for a reassembled handshake message of maximum size,
4107 * together with its reassembly bitmap.
4108 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004109 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004110 * should be sufficient for all practical situations as it allows
4111 * to reassembly a large handshake message (such as a certificate)
4112 * while buffering multiple smaller handshake messages.
4113 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004114 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004115//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004116
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004117//#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 +02004118//#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 +02004119
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004120/**
4121 * Complete list of ciphersuites to use, in order of preference.
4122 *
4123 * \warning No dependency checking is done on that field! This option can only
4124 * be used to restrict the set of available ciphersuites. It is your
4125 * responsibility to make sure the needed modules are active.
4126 *
4127 * Use this to save a few hundred bytes of ROM (default ordering of all
4128 * available ciphersuites) and a few to a few hundred bytes of RAM.
4129 *
4130 * The value below is only an example, not the default.
4131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004132//#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 +02004133
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004134/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004135 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4136 *
4137 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004138 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004139 *
4140 * It must be positive and smaller than UINT32_MAX.
4141 *
4142 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4143 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004144 */
4145//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4146
4147/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004148 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4149 *
Jerry Yucf913512023-11-14 11:06:52 +08004150 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004151 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004152 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004153 * - The client ticket age is the time difference between the time when the
4154 * client proposes to the server to use the ticket and the time the client
4155 * received the ticket from the server.
4156 * - The server ticket age is the time difference between the time when the
4157 * server receives a proposition from the client to use the ticket and the
4158 * time when the ticket was created by the server.
4159 *
Jerry Yucf913512023-11-14 11:06:52 +08004160 * The ages might be different due to the client and server clocks not running
4161 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4162 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4163 * 6s, thus in the worst case clients and servers must sync up their system time
4164 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004165 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004166 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004167 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004168//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004169
4170/**
4171 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4172 *
4173 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4174 *
4175 * This must be less than 256.
4176 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004177//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004178
4179/**
4180 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4181 *
4182 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4183 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4184 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4185 *
4186 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004187//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004188
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004189/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004190//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004191//#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 +01004192
Gilles Peskine611179c2022-04-13 23:04:48 +02004193/** \} name SECTION: Module configuration options */