blob: fa223ffa8d4cfb9137f838b63d060714d4ed8026 [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
Paul Bakker90995b52013-06-24 19:20:35 +0200353/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200354 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200357 * hardware entropy collector.
358 *
359 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000360 * prototype as declared in library/entropy_poll.h, and accept NULL as first
361 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200362 *
363 * Uncomment to use your own hardware entropy collector.
364 */
365//#define MBEDTLS_ENTROPY_HARDWARE_ALT
366
367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000369 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100370 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000371 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100372 * Uncomment this macro to use precomputed AES tables stored in ROM.
373 * Comment this macro to generate AES tables in RAM at runtime.
374 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100375 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
376 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100377 * initialization time before the first AES operation can be performed.
378 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
379 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
380 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100381 *
382 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000385
386/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100387 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200388 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100389 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200390 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100391 * Uncommenting this macro omits 75% of the AES tables from
392 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
393 * by computing their values on the fly during operations
394 * (the tables are entry-wise rotations of one another).
395 *
396 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100397 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100398 * runtime. Specifically, one has to compare 4 accesses within
399 * different tables to 4 accesses with additional arithmetic
400 * operations within the same table. The performance gain/loss
401 * depends on the system and memory details.
402 *
403 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200404 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100405//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200406
407/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800408 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
409 *
410 * Use only 128-bit keys in AES operations to save ROM.
411 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800412 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800413 * or 256-bit keys.
414 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800415 * Uncommenting this macro reduces the size of AES code by ~300 bytes
416 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800417 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800418 * Module: library/aes.c
419 *
420 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800421 */
422//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
423
Gilles Peskinea8861e02023-09-05 20:20:51 +0200424/*
425 * Disable plain C implementation for AES.
426 *
427 * When the plain C implementation is enabled, and an implementation using a
428 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
429 * detection will be used to select between them.
430 *
431 * If only one implementation is present, runtime detection will not be used.
432 * This configuration will crash at runtime if running on a CPU without the
433 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
434 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
435 */
436//#define MBEDTLS_AES_USE_HARDWARE_ONLY
437
Arto Kinnunen732ca322023-04-14 14:26:10 +0800438/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200440 *
441 * Use less ROM for the Camellia implementation (saves about 768 bytes).
442 *
443 * Uncomment this macro to use less memory for Camellia.
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200446
447/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200448 * \def MBEDTLS_CHECK_RETURN_WARNING
449 *
450 * If this macro is defined, emit a compile-time warning if application code
451 * calls a function without checking its return value, but the return value
452 * should generally be checked in portable applications.
453 *
454 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
455 * implemented. Otherwise this option has no effect.
456 *
457 * Uncomment to get warnings on using fallible functions without checking
458 * their return value.
459 *
460 * \note This feature is a work in progress.
461 * Warnings will be added to more functions in the future.
462 *
463 * \note A few functions are considered critical, and ignoring the return
464 * value of these functions will trigger a warning even if this
465 * macro is not defined. To completely disable return value check
466 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
467 */
468//#define MBEDTLS_CHECK_RETURN_WARNING
469
470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200472 *
473 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200475#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200476
477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000479 *
480 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000483
484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000486 *
487 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200489#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000490
491/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100492 * \def MBEDTLS_CIPHER_MODE_OFB
493 *
494 * Enable Output Feedback mode (OFB) for symmetric ciphers.
495 */
496#define MBEDTLS_CIPHER_MODE_OFB
497
498/**
499 * \def MBEDTLS_CIPHER_MODE_XTS
500 *
501 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
502 */
503#define MBEDTLS_CIPHER_MODE_XTS
504
505/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000507 *
508 * Enable NULL cipher.
509 * Warning: Only do so when you know what you are doing. This allows for
510 * encryption or channels without any security!
511 *
Ronald Croncee42702021-04-26 11:34:44 +0200512 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
514 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
516 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
517 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
518 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
519 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
520 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
521 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
522 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
523 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
524 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
525 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
527 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
528 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000529 *
530 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000533
534/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100535 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200536 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100537 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
538 * specific padding modes in the cipher layer with cipher modes that support
539 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200540 *
541 * If you disable all padding modes, only full blocks can be used with CBC.
542 *
543 * Enable padding modes in the cipher layer.
544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545#define MBEDTLS_CIPHER_PADDING_PKCS7
546#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
547#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
548#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200549
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200550/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
551 *
552 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800553 * Without this, CTR_DRBG uses a 256-bit key
554 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200555 */
556//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
557
Paul Bakker48e93c82013-08-14 12:21:18 +0200558/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200559 * Enable the verified implementations of ECDH primitives from Project Everest
560 * (currently only Curve25519). This feature changes the layout of ECDH
561 * contexts and therefore is a compatibility break for applications that access
562 * fields of a mbedtls_ecdh_context structure directly. See also
563 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000564 *
565 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
566 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200567 */
568//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
569
570/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100571 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200572 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100573 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
574 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200575 *
576 * Comment macros to disable the curve and functions for it
577 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200578/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
580#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
581#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
582#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
583#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
584#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
585#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
586#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
587#define MBEDTLS_ECP_DP_BP256R1_ENABLED
588#define MBEDTLS_ECP_DP_BP384R1_ENABLED
589#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200590/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200591#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000592#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200593
594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200596 *
597 * Enable specific 'modulo p' routines for each NIST prime.
598 * Depending on the prime and architecture, makes operations 4 to 8 times
599 * faster on the corresponding curve.
600 *
601 * Comment this macro to disable NIST curves optimisation.
602 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200604
605/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200606 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100607 *
608 * Enable "non-blocking" ECC operations that can return early and be resumed.
609 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200610 * This allows various functions to pause by returning
611 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
612 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
613 * order to further progress and eventually complete their operation. This is
614 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
615 * number of ECC operations a function may perform before pausing; see
616 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100617 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200618 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200619 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100620 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100621 * This option:
622 * - Adds xxx_restartable() variants of existing operations in the
623 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100624 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
625 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100626 * - ECDSA: signature generation & verification;
627 * - PK: signature generation & verification;
628 * - X509: certificate chain verification.
629 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
630 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
631 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
632 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000633 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100634 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100635 * - verification of the server's key exchange signature;
636 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100637 * - generation of the client's signature if client authentication is used,
638 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100639 *
640 * \note In the cases above, the usual SSL/TLS functions, such as
641 * mbedtls_ssl_handshake(), can now return
642 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200643 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100644 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
645 * restartable operations in PK, X.509 and TLS (see above) are not
646 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100647 * PSA, and are not restartable. These are temporary limitations that
648 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200649 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100650 * Requires: MBEDTLS_ECP_C
651 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100652 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100653 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200654//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100655
656/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200657 * Uncomment to enable using new bignum code in the ECC modules.
658 *
659 * \warning This is currently experimental, incomplete and therefore should not
660 * be used in production.
661 */
662//#define MBEDTLS_ECP_WITH_MPI_UINT
663
664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100666 *
667 * Enable deterministic ECDSA (RFC 6979).
668 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
669 * may result in a compromise of the long-term signing key. This is avoided by
670 * the deterministic variant.
671 *
John Durkop36a82e52020-10-26 09:39:05 -0700672 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100673 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100674 * Comment this macro to disable deterministic ECDSA.
675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100677
678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200680 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200681 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200682 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200683 * This enables the following ciphersuites (if other requisites are
684 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
686 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
687 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
688 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
689 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
690 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
691 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
692 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
693 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
694 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200697
698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200699 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200700 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200701 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200702 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200703 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200704 *
705 * This enables the following ciphersuites (if other requisites are
706 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
708 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
709 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
710 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
711 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
712 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
713 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
714 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
715 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
716 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100717 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100718 * \warning Using DHE constitutes a security risk as it
719 * is not possible to validate custom DH parameters.
720 * If possible, it is recommended users should consider
721 * preferring other methods of key exchange.
722 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100723 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200725#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200726
727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200728 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200729 *
730 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
731 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200732 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200733 *
734 * This enables the following ciphersuites (if other requisites are
735 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
737 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
738 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
739 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
740 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
741 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200743#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200744
745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200747 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200748 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200749 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
751 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200752 *
753 * This enables the following ciphersuites (if other requisites are
754 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
756 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
757 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
758 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
759 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
760 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
761 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
762 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
763 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
764 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
765 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
766 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200769
770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200773 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
776 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 *
778 * This enables the following ciphersuites (if other requisites are
779 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
781 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
782 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
783 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
784 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
785 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
786 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
787 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
788 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
789 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
790 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
791 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100792 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100793 * \warning Using DHE constitutes a security risk as it
794 * is not possible to validate custom DH parameters.
795 * If possible, it is recommended users should consider
796 * preferring other methods of key exchange.
797 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100798 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200801
802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200805 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200807 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
808 * MBEDTLS_RSA_C
809 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
812 * This enables the following ciphersuites (if other requisites are
813 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
815 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
816 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
817 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
818 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
819 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
820 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
821 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
822 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
823 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826
827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200829 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200830 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200831 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200832 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
833 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
834 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200835 *
836 * This enables the following ciphersuites (if other requisites are
837 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
839 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
840 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
841 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
842 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
843 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
844 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
845 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
846 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
847 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200850
851/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100853 *
854 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
855 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200856 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
857 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
858 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100859 *
860 * This enables the following ciphersuites (if other requisites are
861 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
863 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
864 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
865 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
866 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
867 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
868 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
869 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
870 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
871 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100872 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100874
875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100877 *
878 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
879 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200880 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
881 * MBEDTLS_RSA_C
882 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100883 *
884 * This enables the following ciphersuites (if other requisites are
885 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
887 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
888 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
889 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
890 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
891 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
892 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
893 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
894 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
895 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100896 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100898
899/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200900 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
901 *
902 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
903 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200904 * \warning This is currently experimental. EC J-PAKE support is based on the
905 * Thread v1.0.0 specification; incompatible changes to the specification
906 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200907 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200908 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100909 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200910 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
911 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100912 * \warning If SHA-256 is provided only by a PSA driver, you must call
Wenxing Houb4d03cc2024-06-19 11:04:13 +0800913 * psa_crypto_init() before the first handshake (even if
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +0100914 * MBEDTLS_USE_PSA_CRYPTO is disabled).
915 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200916 * This enables the following ciphersuites (if other requisites are
917 * enabled as well):
918 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
919 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200920//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200921
922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100924 *
925 * Enhance support for reading EC keys using variants of SEC1 not allowed by
926 * RFC 5915 and RFC 5480.
927 *
928 * Currently this means parsing the SpecifiedECDomain choice of EC
929 * parameters (only known groups are supported, not arbitrary domains, to
930 * avoid validation issues).
931 *
932 * Disable if you only need to support RFC 5915 + 5480 key formats.
933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100935
936/**
Valerio Settiaddeee42023-06-14 10:46:55 +0200937 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
938 *
939 * Enable the support for parsing public keys of type Short Weierstrass
940 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +0200941 * compressed point format. This parsing is done through ECP module's functions.
942 *
943 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
944 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
945 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +0200946 */
947#define MBEDTLS_PK_PARSE_EC_COMPRESSED
948
949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100951 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952 * Enable a dummy error function to make use of mbedtls_strerror() in
953 * third party libraries easier when MBEDTLS_ERROR_C is disabled
954 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200955 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
957 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100958 *
959 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100963
964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000966 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200967 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000972
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000975 *
976 * Enable functions that use the filesystem.
977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000979
980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000982 *
TRodziewicz15a7b732021-06-16 11:22:53 +0200983 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +0000984 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700985 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000986 * application.
987 *
988 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200990//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000991
992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000994 *
995 * Do not use built-in platform entropy functions.
996 * This is useful if your platform does not support
997 * standards like the /dev/urandom or Windows CryptoAPI.
998 *
999 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001000 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001001//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001002
1003/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001005 *
1006 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1007 * default SHA-512 based one (if both are available).
1008 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001010 *
1011 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1012 * if you have performance concerns.
1013 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * This option is only useful if both MBEDTLS_SHA256_C and
1015 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001018
1019/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001020 * \def MBEDTLS_ENTROPY_NV_SEED
1021 *
1022 * Enable the non-volatile (NV) seed file-based entropy source.
1023 * (Also enables the NV seed read/write functions in the platform layer)
1024 *
1025 * This is crucial (if not required) on systems that do not have a
1026 * cryptographic entropy source (in hardware or kernel) available.
1027 *
1028 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1029 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001030 * \note The read/write functions that are used by the entropy source are
1031 * determined in the platform layer, and can be modified at runtime and/or
1032 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1033 *
1034 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001035 * with regular fopen(), please make sure you make a seedfile with the
1036 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1037 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001038 * and written to or you will get an entropy source error! The default
1039 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1040 * bytes from the file.
1041 *
1042 * \note The entropy collector will write to the seed file before entropy is
1043 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001044 */
1045//#define MBEDTLS_ENTROPY_NV_SEED
1046
Ronald Cron71016a92020-08-28 19:01:50 +02001047/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001048 *
Ronald Cron71016a92020-08-28 19:01:50 +02001049 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001050 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001051 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1052 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001053 *
1054 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001055 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001056 */
Ronald Cron71016a92020-08-28 19:01:50 +02001057//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001058
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001061 *
1062 * Enable debugging of buffer allocator memory issues. Automatically prints
1063 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1064 * function for 'debug output' of allocated memory.
1065 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001067 *
1068 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001071
1072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001074 *
1075 * Include backtrace information with each allocated block.
1076 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001078 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001079 *
1080 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001083
1084/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001086 *
1087 * Support external private RSA keys (eg from a HSM) in the PK layer.
1088 *
1089 * Comment this macro to disable support for external private RSA keys.
1090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001092
1093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001095 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001096 * Enable support for PKCS#1 v1.5 encoding.
1097 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001098 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001099 *
Paul Bakker48377d92013-08-30 12:06:24 +02001100 * This enables support for PKCS#1 v1.5 operations.
1101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001103
1104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001106 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001107 * Enable support for PKCS#1 v2.1 encoding.
1108 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001109 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001110 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001111 * \warning If using a hash that is only provided by PSA drivers, you must
1112 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001113 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001114 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001117
Steven Cooreman6801f082021-02-19 17:21:22 +01001118/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1119 *
1120 * Enable support for platform built-in keys. If you enable this feature,
1121 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1122 * See the documentation of that function for more information.
1123 *
1124 * Built-in keys are typically derived from a hardware unique key or
1125 * stored in a secure element.
1126 *
1127 * Requires: MBEDTLS_PSA_CRYPTO_C.
1128 *
1129 * \warning This interface is experimental and may change or be removed
1130 * without notice.
1131 */
1132//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1133
Ronald Cron3768ac12021-01-26 16:58:00 +01001134/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1135 *
1136 * Enable support for PSA crypto client.
1137 *
1138 * \note This option allows to include the code necessary for a PSA
1139 * crypto client when the PSA crypto implementation is not included in
1140 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1141 * code to set and get PSA key attributes.
1142 * The development of PSA drivers partially relying on the library to
1143 * fulfill the hardware gaps is another possible usage of this option.
1144 *
1145 * \warning This interface is experimental and may change or be removed
1146 * without notice.
1147 */
1148//#define MBEDTLS_PSA_CRYPTO_CLIENT
1149
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001150/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1151 *
1152 * Make the PSA Crypto module use an external random generator provided
1153 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1154 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001155 * \note This random generator must deliver random numbers with cryptographic
1156 * quality and high performance. It must supply unpredictable numbers
1157 * with a uniform distribution. The implementation of this function
1158 * is responsible for ensuring that the random generator is seeded
1159 * with sufficient entropy. If you have a hardware TRNG which is slow
1160 * or delivers non-uniform output, declare it as an entropy source
1161 * with mbedtls_entropy_add_source() instead of enabling this option.
1162 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001163 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001164 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1165 * and define a function called mbedtls_psa_external_get_random()
1166 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001167 * ```
1168 * psa_status_t mbedtls_psa_external_get_random(
1169 * mbedtls_psa_external_random_context_t *context,
1170 * uint8_t *output, size_t output_size, size_t *output_length);
1171 * );
1172 * ```
1173 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001174 * The function must fill the \c output buffer with \c output_size bytes
1175 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001176 *
1177 * Requires: MBEDTLS_PSA_CRYPTO_C
1178 *
1179 * \warning If you enable this option, code that uses the PSA cryptography
1180 * interface will not use any of the entropy sources set up for
1181 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1182 * enables.
1183 *
1184 * \note This option is experimental and may be removed without notice.
1185 */
1186//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1187
Paul Bakker9dcc3222011-03-08 14:16:06 +00001188/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001189 * \def MBEDTLS_PSA_CRYPTO_SPM
1190 *
1191 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1192 * Partition Manager) integration which separates the code into two parts: a
1193 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1194 * Environment).
1195 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001196 * If you enable this option, your build environment must include a header
1197 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1198 * header files, or in another directory on the compiler's include search
1199 * path). Alternatively, your platform may customize the header
1200 * `psa/crypto_platform.h`, in which case it can skip or replace the
1201 * inclusion of `"crypto_spe.h"`.
1202 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001203 * Module: library/psa_crypto.c
1204 * Requires: MBEDTLS_PSA_CRYPTO_C
1205 *
1206 */
1207//#define MBEDTLS_PSA_CRYPTO_SPM
1208
1209/**
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02001210 * \def MBEDTLS_PSA_KEY_STORE_DYNAMIC
1211 *
1212 * Dynamically resize the PSA key store to accommodate any number of
1213 * volatile keys (until the heap memory is exhausted).
1214 *
1215 * If this option is disabled, the key store has a fixed size
1216 * #MBEDTLS_PSA_KEY_SLOT_COUNT for volatile keys and loaded persistent keys
1217 * together.
1218 *
1219 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
1220 *
1221 * Module: library/psa_crypto.c
1222 * Requires: MBEDTLS_PSA_CRYPTO_C
1223 */
1224#define MBEDTLS_PSA_KEY_STORE_DYNAMIC
1225
1226/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001227 * Uncomment to enable p256-m. This is an alternative implementation of
1228 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1229 * Compared to the default implementation:
1230 *
1231 * - p256-m has a much smaller code size and RAM footprint.
1232 * - p256-m is only available via the PSA API. This includes the pk module
1233 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1234 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1235 * over the core arithmetic, or deterministic derivation of keys.
1236 *
1237 * We recommend enabling this option if your application uses the PSA API
1238 * and the only elliptic curve support it needs is ECDH and ECDSA over
1239 * SECP256R1.
1240 *
1241 * If you enable this option, you do not need to enable any ECC-related
1242 * MBEDTLS_xxx option. You do need to separately request support for the
1243 * cryptographic mechanisms through the PSA API:
1244 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1245 * configuration;
1246 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1247 * - #PSA_WANT_ECC_SECP_R1_256;
1248 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1249 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1250 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1251 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1252 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001253 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001254 * \note To benefit from the smaller code size of p256-m, make sure that you
1255 * do not enable any ECC-related option not supported by p256-m: this
1256 * would cause the built-in ECC implementation to be built as well, in
1257 * order to provide the required option.
1258 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001259 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1260 * SECP256R1 are disabled as they are not supported by this driver.
1261 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1262 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001263 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001264 */
1265//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1266
1267/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001268 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001269 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001270 * Enable support for entropy injection at first boot. This feature is
1271 * required on systems that do not have a built-in entropy source (TRNG).
1272 * This feature is currently not supported on systems that have a built-in
1273 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001274 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001275 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001276 *
1277 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001278//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001279
1280/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001281 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001282 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001283 * Assume all buffers passed to PSA functions are owned exclusively by the
1284 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001285 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001286 * This option may be enabled if all buffers passed to any PSA function reside
1287 * in memory that is accessible only to the PSA function during its execution.
1288 *
1289 * This option MUST be disabled whenever buffer arguments are in memory shared
1290 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001291 * across a trust boundary.
1292 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001293 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001294 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001295 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001296 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001297 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001298//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001299
1300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001302 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001303 * Do not use the Chinese Remainder Theorem
1304 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001305 *
1306 * Uncomment this macro to disable the use of CRT in RSA.
1307 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001310
1311/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001313 *
1314 * Enable the checkup functions (*_self_test).
1315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001317
1318/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001319 * \def MBEDTLS_SHA256_SMALLER
1320 *
1321 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1322 * lower performance.
1323 *
Adam Wolf039080f2019-09-10 09:53:08 -05001324 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001325 * performance and size. This version optimizes more aggressively for size at
1326 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1327 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1328 * 30%.
1329 *
1330 * Uncomment to enable the smaller implementation of SHA256.
1331 */
1332//#define MBEDTLS_SHA256_SMALLER
1333
1334/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001335 * \def MBEDTLS_SHA512_SMALLER
1336 *
1337 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1338 * lower performance.
1339 *
1340 * Uncomment to enable the smaller implementation of SHA512.
1341 */
1342//#define MBEDTLS_SHA512_SMALLER
1343
1344/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001346 *
1347 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001348 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001349 * with other servers, only debugging of failures is harder.
1350 *
1351 * The advantage of not sending alert messages, is that no information is given
1352 * about reasons for failures thus preventing adversaries of gaining intel.
1353 *
1354 * Enable sending of all alert messages
1355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001357
1358/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001359 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1360 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001361 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001362 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001363 * in the underlying transport. The CID functionality is described
1364 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001365 *
1366 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001367 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1368 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1369 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001370 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001371 * The maximum lengths of outgoing and incoming CIDs can be configured
1372 * through the options
1373 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1374 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1375 *
1376 * Requires: MBEDTLS_SSL_PROTO_DTLS
1377 *
1378 * Uncomment to enable the Connection ID extension.
1379 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001380#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1381
1382
1383/**
1384 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1385 *
1386 * Defines whether RFC 9146 (default) or the legacy version
1387 * (version draft-ietf-tls-dtls-connection-id-05,
1388 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1389 * is used.
1390 *
1391 * Set the value to 0 for the standard version, and
1392 * 1 for the legacy draft version.
1393 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001394 * \deprecated Support for the legacy version of the DTLS
1395 * Connection ID feature is deprecated. Please
1396 * switch to the standardized version defined
1397 * in RFC 9146 enabled by utilizing
1398 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1399 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1400 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001401 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1402 */
1403#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001404
1405/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001406 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1407 *
1408 * Enable asynchronous external private key operations in SSL. This allows
1409 * you to configure an SSL connection to call an external cryptographic
1410 * module to perform private key operations instead of performing the
1411 * operation inside the library.
1412 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001413 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001414 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001415//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001416
1417/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001418 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1419 *
1420 * Enable serialization of the TLS context structures, through use of the
1421 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1422 *
1423 * This pair of functions allows one side of a connection to serialize the
1424 * context associated with the connection, then free or re-use that context
1425 * while the serialized state is persisted elsewhere, and finally deserialize
1426 * that state to a live context for resuming read/write operations on the
1427 * connection. From a protocol perspective, the state of the connection is
1428 * unaffected, in particular this is entirely transparent to the peer.
1429 *
1430 * Note: this is distinct from TLS session resumption, which is part of the
1431 * protocol and fully visible by the peer. TLS session resumption enables
1432 * establishing new connections associated to a saved session with shorter,
1433 * lighter handshakes, while context serialization is a local optimization in
1434 * handling a single, potentially long-lived connection.
1435 *
1436 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1437 * saved after the handshake to allow for more efficient serialization, so if
1438 * you don't need this feature you'll save RAM by disabling it.
1439 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001440 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1441 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001442 * Comment to disable the context serialization APIs.
1443 */
1444#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1445
1446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001448 *
1449 * Enable the debug messages in SSL module for all issues.
1450 * Debug messages have been disabled in some places to prevent timing
1451 * attacks due to (unbalanced) debugging function calls.
1452 *
1453 * If you need all error reporting you should enable this during debugging,
1454 * but remove this for production servers that should log as well.
1455 *
1456 * Uncomment this macro to report all debug messages on errors introducing
1457 * a timing side-channel.
1458 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001463 *
1464 * Enable support for Encrypt-then-MAC, RFC 7366.
1465 *
1466 * This allows peers that both support it to use a more robust protection for
1467 * ciphersuites using CBC, providing deep resistance against timing attacks
1468 * on the padding or underlying cipher.
1469 *
1470 * This only affects CBC ciphersuites, and is useless if none is defined.
1471 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001472 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001473 *
1474 * Comment this macro to disable support for Encrypt-then-MAC
1475 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001479 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001480 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1481 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001482 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001483 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001484 * attacks, but it is recommended to always use it (even if you disable
1485 * renegotiation), since it actually fixes a more fundamental issue in the
1486 * original SSL/TLS design, and has implications beyond Triple Handshake.
1487 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001488 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001489 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001490 * Comment this macro to disable support for Extended Master Secret.
1491 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001493
Paul Bakkerd66f0702013-01-31 16:57:45 +01001494/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001495 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1496 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001497 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001498 * giving access to the peer's certificate after completion of the handshake.
1499 *
1500 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1501 * recommended to disable this option for reduced RAM usage.
1502 *
1503 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1504 * defined, but always returns \c NULL.
1505 *
1506 * \note This option has no influence on the protection against the
1507 * triple handshake attack. Even if it is disabled, Mbed TLS will
1508 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001509 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001510 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001511 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001512 *
1513 * Comment this macro to disable storing the peer's certificate
1514 * after the handshake.
1515 */
1516#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1517
1518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001519 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001520 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001521 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001522 *
1523 * The two main uses of renegotiation are (1) refresh keys on long-lived
1524 * connections and (2) client authentication after the initial handshake.
1525 * If you don't need renegotiation, it's probably better to disable it, since
1526 * it has been associated with security issues in the past and is easy to
1527 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001528 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001529 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1530 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001531 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001532 *
1533 * \note Even if this option is disabled, both client and server are aware
1534 * of the Renegotiation Indication Extension (RFC 5746) used to
1535 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1536 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1537 * configuration of this extension).
1538 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001541
1542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001544 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001545 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001546 *
1547 * Comment this macro to disable support for the max_fragment_length extension
1548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001550
1551/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001552 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1553 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001554 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001555 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001556 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1557 *
1558 * Uncomment this macro to enable support for the record_size_limit extension
1559 */
1560//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1561
1562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001564 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001565 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001566 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001567 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001568 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1569 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001570 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001571 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001572 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001573 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1574 * are only provided by PSA drivers, you must call psa_crypto_init() before
1575 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001576 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001577 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001580
1581/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001582 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001583 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001584 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001585 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001586 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001587 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001588 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001589 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001590 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001591 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001592 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1593 * directly performed by TLS 1.3 code. As a consequence, you must
1594 * call psa_crypto_init() before the first TLS 1.3 handshake.
1595 *
1596 * \note Cryptographic operations performed indirectly via another module
1597 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1598 * running handshake hash) only use PSA crypto if
1599 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001600 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001601 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001602 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001603#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001604
1605/**
Ronald Cronab65c522021-11-24 10:47:20 +01001606 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1607 *
1608 * Enable TLS 1.3 middlebox compatibility mode.
1609 *
1610 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1611 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1612 * expecting TLS 1.2 traffic.
1613 *
1614 * Turning on the compatibility mode comes at the cost of a few added bytes
1615 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1616 * that don't use it. Therefore, unless transmission bandwidth is critical and
1617 * you know that middlebox compatibility issues won't occur, it is therefore
1618 * recommended to set this option.
1619 *
1620 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001621 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1622 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001623 *
1624 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001625#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001626
1627/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001628 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1629 *
1630 * Enable TLS 1.3 PSK key exchange mode.
1631 *
1632 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1633 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1634 * effect on the build.
1635 *
1636 */
1637#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1638
1639/**
1640 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1641 *
1642 * Enable TLS 1.3 ephemeral key exchange mode.
1643 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001644 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001645 * MBEDTLS_X509_CRT_PARSE_C
1646 * and at least one of:
1647 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1648 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001649 *
1650 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1651 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1652 * effect on the build.
1653 *
1654 */
1655#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1656
1657/**
1658 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1659 *
1660 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1661 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001662 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001663 *
1664 * Comment to disable support for the PSK ephemeral key exchange mode in
1665 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1666 * have any effect on the build.
1667 *
1668 */
1669#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1670
1671/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 * \def MBEDTLS_SSL_EARLY_DATA
1673 *
1674 * Enable support for RFC 8446 TLS 1.3 early data.
1675 *
1676 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1677 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1678 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1679 *
1680 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1681 * is not enabled, this option does not have any effect on the build.
1682 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001683 * \note The maximum amount of early data can be set with
1684 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1685 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001687//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001688
1689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001691 *
1692 * Enable support for DTLS (all available versions).
1693 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001694 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001695 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001696 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001697 *
1698 * Comment this macro to disable support for DTLS
1699 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001701
1702/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001704 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001705 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001706 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001707 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001710
1711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001713 *
1714 * Enable support for the anti-replay mechanism in DTLS.
1715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716 * Requires: MBEDTLS_SSL_TLS_C
1717 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001718 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001719 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001720 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001721 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001722 * Comment this to disable anti-replay in DTLS.
1723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001725
1726/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001728 *
1729 * Enable support for HelloVerifyRequest on DTLS servers.
1730 *
1731 * This feature is highly recommended to prevent DTLS servers being used as
1732 * amplifiers in DoS attacks against other hosts. It should always be enabled
1733 * unless you know for sure amplification cannot be a problem in the
1734 * environment in which your server operates.
1735 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001736 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001738 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001739 *
1740 * Comment this to disable support for HelloVerifyRequest.
1741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001743
1744/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001745 * \def MBEDTLS_SSL_DTLS_SRTP
1746 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001747 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001748 * through the use_srtp extension.
1749 *
1750 * \note This feature provides the minimum functionality required
1751 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1752 * the associated SRTP packet protection key material.
1753 * In particular, the SRTP packet protection itself, as well as the
1754 * demultiplexing of RTP and DTLS packets at the datagram layer
1755 * (see Section 5 of RFC 5764), are not handled by this feature.
1756 * Instead, after successful completion of a handshake negotiating
1757 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001758 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001759 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1760 * (this is implemented in the SSL example programs).
1761 * The resulting key should then be passed to an SRTP stack.
1762 *
1763 * Setting this option enables the runtime API
1764 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1765 * through which the supported DTLS-SRTP protection
1766 * profiles can be configured. You must call this API at
1767 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001768 *
1769 * Requires: MBEDTLS_SSL_PROTO_DTLS
1770 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001771 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001772 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001773//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001774
1775/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001776 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1777 *
1778 * Enable server-side support for clients that reconnect from the same port.
1779 *
1780 * Some clients unexpectedly close the connection and try to reconnect using the
1781 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001782 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001783 * flag enables that support.
1784 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001785 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001786 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001787 * Comment this to disable support for clients reusing the source port.
1788 */
1789#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1790
1791/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001793 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001794 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001795 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001796 * session store remains the responsibility of the application, though).
1797 * Server-side, you also need to provide callbacks for writing and parsing
1798 * tickets, including authenticated encryption and key management. Example
1799 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001800 *
1801 * Comment this macro to disable support for SSL session tickets
1802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001804
1805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001808 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001811 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001812 * Comment this macro to disable support for server name indication in SSL
1813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001815
1816/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001817 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1818 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001819 * When this option is enabled, the SSL buffer will be resized automatically
1820 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001821 *
1822 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001823 */
1824//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1825
1826/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001827 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1828 *
1829 * Enable testing of the constant-flow nature of some sensitive functions with
1830 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001831 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001832 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001833 * This setting requires compiling with clang -fsanitize=memory. The test
1834 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001835 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001836 * \warning This macro is only used for extended testing; it is not considered
1837 * part of the library's API, so it may change or disappear at any time.
1838 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001839 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001840 */
1841//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1842
1843/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001844 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1845 *
1846 * Enable testing of the constant-flow nature of some sensitive functions with
1847 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001848 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001849 *
1850 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * testing if the tests suites are run with valgrind's memcheck. This can be
1852 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1853 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001854 *
1855 * \warning This macro is only used for extended testing; it is not considered
1856 * part of the library's API, so it may change or disappear at any time.
1857 *
1858 * Uncomment to enable testing of the constant-flow nature of selected code.
1859 */
1860//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1861
1862/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001863 * \def MBEDTLS_TEST_HOOKS
1864 *
1865 * Enable features for invasive testing such as introspection functions and
1866 * hooks for fault injection. This enables additional unit tests.
1867 *
1868 * Merely enabling this feature should not change the behavior of the product.
1869 * It only adds new code, and new branching points where the default behavior
1870 * is the same as when this feature is disabled.
1871 * However, this feature increases the attack surface: there is an added
1872 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1873 * Therefore this feature must never be enabled in production.
1874 *
1875 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1876 * information.
1877 *
1878 * Uncomment to enable invasive tests.
1879 */
1880//#define MBEDTLS_TEST_HOOKS
1881
1882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001884 *
1885 * Provide your own alternate threading implementation.
1886 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001888 *
1889 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001892
1893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001895 *
1896 * Enable the pthread wrapper layer for the threading layer.
1897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001899 *
1900 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001903
1904/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001905 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1906 *
John Durkop185764f2020-10-12 21:32:12 -07001907 * This setting allows support for cryptographic mechanisms through the PSA
1908 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001909 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001910 * When this option is disabled, the PSA API exposes the cryptographic
1911 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1912 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001913 *
1914 * When this option is enabled, the PSA API exposes the cryptographic
1915 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1916 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1917 * automatically enabled if required (i.e. if no PSA driver provides the
1918 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1919 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001920 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001921 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001922 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001923 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02001924 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
1925 * symbols is not completely finalized yet, and the configuration
1926 * tooling is not ideally adapted to having two separate configuration
1927 * files.
1928 * Future minor releases of Mbed TLS may make minor changes to those
1929 * symbols, but we will endeavor to provide a transition path.
1930 * Nonetheless, this option is considered mature enough to use in
1931 * production, as long as you accept that you may need to make
1932 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07001933 */
1934//#define MBEDTLS_PSA_CRYPTO_CONFIG
1935
1936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001938 *
1939 * Allow run-time checking of compile-time enabled features. Thus allowing users
1940 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001944 *
1945 * Comment this to disable run-time checking and save ROM space
1946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001948
1949/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001950 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1951 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001952 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001953 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1954 * the set of trusted certificates through a callback instead of a linked
1955 * list.
1956 *
1957 * This is useful for example in environments where a large number of trusted
1958 * certificates is present and storing them in a linked list isn't efficient
1959 * enough, or when the set of trusted certificates changes frequently.
1960 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001961 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001962 * `mbedtls_ssl_conf_ca_cb()` for more information.
1963 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001964 * Requires: MBEDTLS_X509_CRT_PARSE_C
1965 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001966 * Uncomment to enable trusted certificate callbacks.
1967 */
1968//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1969
1970/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001971 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001972 *
Chris Jones2c745862020-12-16 11:41:06 +00001973 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001974 *
Chris Jones2c745862020-12-16 11:41:06 +00001975 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001976 * and other functions/constants only used by these functions, thus reducing
1977 * the code footprint by several KB.
1978 */
Chris Jones2c745862020-12-16 11:41:06 +00001979//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001980
1981/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001982 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001983 *
1984 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1985 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1986 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03001987 * Requires: MBEDTLS_PKCS1_V21
1988 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001989 * Comment this macro to disallow using RSASSA-PSS in certificates.
1990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001992/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001993
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001994/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001995 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001996 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001997 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001998 * \{
1999 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002000
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002003 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002004 * Enable AES-NI support on x86-64 or x86-32.
2005 *
2006 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002007 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002008 * - GCC, x86-64, target not explicitly supporting AESNI:
2009 * requires MBEDTLS_HAVE_ASM.
2010 * - GCC, x86-32, target not explicitly supporting AESNI:
2011 * not supported.
2012 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2013 * For this assembly-less implementation, you must currently compile
2014 * `library/aesni.c` and `library/aes.c` with machine options to enable
2015 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2016 * `clang -maes -mpclmul`.
2017 * - Non-x86 targets: this option is silently ignored.
2018 * - Other compilers: this option is silently ignored.
2019 *
2020 * \note
2021 * Above, "GCC" includes compatible compilers such as Clang.
2022 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002023 *
2024 * Module: library/aesni.c
2025 * Caller: library/aes.c
2026 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002027 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002028 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002029 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002032
2033/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002034 * \def MBEDTLS_AESCE_C
2035 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002036 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002037 *
2038 * Module: library/aesce.c
2039 * Caller: library/aes.c
2040 *
Jerry Yuf015a932023-04-25 10:38:03 +08002041 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002042 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002043 * \warning Runtime detection only works on Linux. For non-Linux operating
2044 * system, Armv8-A Cryptographic Extensions must be supported by
2045 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002046 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002047 * \note Minimum compiler versions for this feature when targeting aarch64
2048 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2049 * Minimum compiler versions for this feature when targeting 32-bit
2050 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002051 *
2052 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2053 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002054 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002055 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002056 */
2057#define MBEDTLS_AESCE_C
2058
2059/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002061 *
2062 * Enable the AES block cipher.
2063 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002064 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002065 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002066 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002067 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002068 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002069 * This module enables the following ciphersuites (if other requisites are
2070 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2073 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2074 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2075 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2076 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2077 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2078 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2080 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2081 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2082 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2083 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2084 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2085 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2087 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2088 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2089 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2090 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2091 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2092 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2093 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2094 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2095 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2096 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2097 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2098 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2099 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2100 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2101 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2102 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2103 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2104 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2105 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2106 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2107 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2108 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2109 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2110 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2111 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2112 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2113 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2115 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2116 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2118 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2119 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2120 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2121 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2122 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002123 *
Paul Bakkercff68422013-09-15 20:43:33 +02002124 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002127
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002130 *
2131 * Enable the generic ASN1 parser.
2132 *
2133 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002134 * Caller: library/x509.c
2135 * library/dhm.c
2136 * library/pkcs12.c
2137 * library/pkcs5.c
2138 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002141
2142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002144 *
2145 * Enable the generic ASN1 writer.
2146 *
2147 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002148 * Caller: library/ecdsa.c
2149 * library/pkwrite.c
2150 * library/x509_create.c
2151 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002152 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002153 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002155
2156/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002158 *
2159 * Enable the Base64 module.
2160 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002162 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002164 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002167
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002168/**
Yanray Wange367e472023-10-31 17:23:04 +08002169 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2170 *
2171 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2172 *
2173 * \note This feature is incompatible with insecure block cipher,
2174 * MBEDTLS_DES_C, and cipher modes which always require decryption
2175 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002176 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2177 * this feature is incompatible with following supported PSA equivalence,
2178 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2179 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002180 *
2181 * Module: library/aes.c
2182 * library/aesce.c
2183 * library/aesni.c
2184 * library/aria.c
2185 * library/camellia.c
2186 * library/cipher.c
2187 */
2188//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2189
2190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002191 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002192 *
Paul Bakker9a736322012-11-14 12:39:52 +00002193 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002194 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002195 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002196 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002197 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002198 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002199 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002200 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002201 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002202 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002203 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002204 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002205 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002206 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002209
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002212 *
2213 * Enable the Camellia block cipher.
2214 *
Paul Bakker38119b12009-01-10 23:31:23 +00002215 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002216 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002217 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002218 * This module enables the following ciphersuites (if other requisites are
2219 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2222 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2223 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2224 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2225 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2226 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2227 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2228 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2229 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2230 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2231 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2232 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2233 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2234 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2235 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2237 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2238 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2239 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2240 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2241 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2242 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2243 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2244 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2245 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2246 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2248 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2249 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2250 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2251 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2252 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2255 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2257 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002259#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002260
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002261/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002262 * \def MBEDTLS_ARIA_C
2263 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002264 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002265 *
2266 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002267 * Caller: library/cipher.c
2268 *
2269 * This module enables the following ciphersuites (if other requisites are
2270 * enabled as well):
2271 *
2272 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2274 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2276 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2277 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2280 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2281 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2283 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2284 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2285 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2287 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2288 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2289 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2290 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2292 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2293 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2294 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2296 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2297 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2298 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2299 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002300 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2301 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2302 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2303 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002304 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2305 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002306 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002307#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002308
2309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002311 *
2312 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2313 *
2314 * Module: library/ccm.c
2315 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002316 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2317 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002318 *
2319 * This module enables the AES-CCM ciphersuites, if other requisites are
2320 * enabled as well.
2321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002323
2324/**
Daniel King34b822c2016-05-15 17:28:08 -03002325 * \def MBEDTLS_CHACHA20_C
2326 *
2327 * Enable the ChaCha20 stream cipher.
2328 *
2329 * Module: library/chacha20.c
2330 */
2331#define MBEDTLS_CHACHA20_C
2332
2333/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002334 * \def MBEDTLS_CHACHAPOLY_C
2335 *
2336 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2337 *
2338 * Module: library/chachapoly.c
2339 *
2340 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2341 */
2342#define MBEDTLS_CHACHAPOLY_C
2343
2344/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002345 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002346 *
2347 * Enable the generic cipher layer.
2348 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002349 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002350 * Caller: library/ccm.c
2351 * library/cmac.c
2352 * library/gcm.c
2353 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002354 * library/pkcs12.c
2355 * library/pkcs5.c
2356 * library/psa_crypto_aead.c
2357 * library/psa_crypto_mac.c
2358 * library/ssl_ciphersuites.c
2359 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002360 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002361 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2362 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002363 *
2364 * Uncomment to enable generic cipher wrappers.
2365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002366#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002367
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002368/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002369 * \def MBEDTLS_CMAC_C
2370 *
Simon Butcher327398a2016-10-05 14:09:11 +01002371 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2372 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002373 *
2374 * Module: library/cmac.c
2375 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002376 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002377 *
2378 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002379#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002380
2381/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002382 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002383 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002384 * Enable the CTR_DRBG AES-based random generator.
2385 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002386 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002387 *
Wenxing Houb4d03cc2024-06-19 11:04:13 +08002388 * AES support can either be achieved through builtin (MBEDTLS_AES_C) or PSA.
Valerio Setti7ab90722023-11-23 16:29:51 +01002389 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2390 * is used.
2391 *
2392 * \warning When using PSA, the user should call `psa_crypto_init()` before
2393 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2394 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002395 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2396 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002397 * \note To achieve a 256-bit security strength with CTR_DRBG,
2398 * you must use AES-256 *and* use sufficient entropy.
2399 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002400 *
2401 * Module: library/ctr_drbg.c
2402 * Caller:
2403 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002404 * Requires: MBEDTLS_AES_C or
2405 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2406 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002407 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002408 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002411
2412/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002414 *
2415 * Enable the debug functions.
2416 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002417 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002418 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002419 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002420 * library/ssl_tls12_*.c
2421 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002422 *
2423 * This module provides debugging functions.
2424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002426
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002429 *
2430 * Enable the DES block cipher.
2431 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002432 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002433 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002434 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002435 *
Paul Bakkercff68422013-09-15 20:43:33 +02002436 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002437 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002438 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002439 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002442
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002445 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002446 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002447 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002448 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002449 * Caller: library/ssl_tls.c
2450 * library/ssl*_client.c
2451 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002453 * This module is used by the following key exchanges:
2454 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002455 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002456 * \warning Using DHE constitutes a security risk as it
2457 * is not possible to validate custom DH parameters.
2458 * If possible, it is recommended users should consider
2459 * preferring other methods of key exchange.
2460 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002461 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002463#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002464
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002467 *
2468 * Enable the elliptic curve Diffie-Hellman library.
2469 *
2470 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002471 * Caller: library/psa_crypto.c
2472 * library/ssl_tls.c
2473 * library/ssl*_client.c
2474 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002475 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002476 * This module is used by the following key exchanges:
2477 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002478 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002482
2483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002484 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002485 *
2486 * Enable the elliptic curve DSA library.
2487 *
2488 * Module: library/ecdsa.c
2489 * Caller:
2490 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002491 * This module is used by the following key exchanges:
2492 * ECDHE-ECDSA
2493 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002494 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2495 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2496 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002499
2500/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002501 * \def MBEDTLS_ECJPAKE_C
2502 *
2503 * Enable the elliptic curve J-PAKE library.
2504 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002505 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2506 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002507 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002508 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002509 * Module: library/ecjpake.c
2510 * Caller:
2511 *
2512 * This module is used by the following key exchanges:
2513 * ECJPAKE
2514 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002515 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002516 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002517 * \warning If using a hash that is only provided by PSA drivers, you must
2518 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002519 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002520#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002521
2522/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002524 *
2525 * Enable the elliptic curve over GF(p) library.
2526 *
2527 * Module: library/ecp.c
2528 * Caller: library/ecdh.c
2529 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002530 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002531 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002532 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002535
2536/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002538 *
2539 * Enable the platform-specific entropy code.
2540 *
2541 * Module: library/entropy.c
2542 * Caller:
2543 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002545 *
2546 * This module provides a generic entropy pool
2547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002549
2550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002552 *
2553 * Enable error code to error string conversion.
2554 *
2555 * Module: library/error.c
2556 * Caller:
2557 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002558 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002561
2562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002564 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002565 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002566 *
2567 * Module: library/gcm.c
2568 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002569 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2570 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002571 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002572 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2573 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002576
2577/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002578 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002579 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002580 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002581 * Can significantly increase throughput on systems without GCM hardware
2582 * acceleration (e.g., AESNI, AESCE).
2583 *
Matthias Schulz78266782024-02-08 13:54:48 +01002584 * The mbedtls_gcm_context size will increase by 3840 bytes.
2585 * The code size will increase by roughly 344 bytes.
2586 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002587 * Module: library/gcm.c
2588 *
2589 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002590 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002591//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002592
2593/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002594 * \def MBEDTLS_HKDF_C
2595 *
2596 * Enable the HKDF algorithm (RFC 5869).
2597 *
2598 * Module: library/hkdf.c
2599 * Caller:
2600 *
2601 * Requires: MBEDTLS_MD_C
2602 *
2603 * This module adds support for the Hashed Message Authentication Code
2604 * (HMAC)-based key derivation function (HKDF).
2605 */
2606#define MBEDTLS_HKDF_C
2607
2608/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002610 *
2611 * Enable the HMAC_DRBG random generator.
2612 *
2613 * Module: library/hmac_drbg.c
2614 * Caller:
2615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002616 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002617 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002618 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002621
2622/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002623 * \def MBEDTLS_LMS_C
2624 *
2625 * Enable the LMS stateful-hash asymmetric signature algorithm.
2626 *
2627 * Module: library/lms.c
2628 * Caller:
2629 *
Raef Colesab4f8742022-09-01 12:24:31 +01002630 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002631 *
Raef Colesab4f8742022-09-01 12:24:31 +01002632 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002633 */
2634#define MBEDTLS_LMS_C
2635
2636/**
Raef Colesab4f8742022-09-01 12:24:31 +01002637 * \def MBEDTLS_LMS_PRIVATE
2638 *
2639 * Enable LMS private-key operations and signing code. Functions enabled by this
2640 * option are experimental, and should not be used in production.
2641 *
2642 * Requires: MBEDTLS_LMS_C
2643 *
2644 * Uncomment to enable the LMS signature algorithm and private key operations.
2645 */
Raef Coles5127e852022-10-07 10:35:56 +01002646//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002647
2648/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002649 * \def MBEDTLS_NIST_KW_C
2650 *
2651 * Enable the Key Wrapping mode for 128-bit block ciphers,
2652 * as defined in NIST SP 800-38F. Only KW and KWP modes
2653 * are supported. At the moment, only AES is approved by NIST.
2654 *
2655 * Module: library/nist_kw.c
2656 *
2657 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2658 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002659#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002660
2661/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002662 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002663 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002664 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002665 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002666 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2667 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002668 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002669 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002670 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002671 * Caller: library/constant_time.c
2672 * library/ecdsa.c
2673 * library/ecjpake.c
2674 * library/hkdf.c
2675 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002676 * library/pk.c
2677 * library/pkcs5.c
2678 * library/pkcs12.c
2679 * library/psa_crypto_ecp.c
2680 * library/psa_crypto_rsa.c
2681 * library/rsa.c
2682 * library/ssl_cookie.c
2683 * library/ssl_msg.c
2684 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002685 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002686 * library/x509_crt.c
2687 * library/x509write_crt.c
2688 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002689 *
2690 * Uncomment to enable generic message digest wrappers.
2691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002693
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002696 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002697 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002698 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002699 * Module: library/md5.c
2700 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002701 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002702 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002703 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002704 * This module is required for TLS 1.2 depending on the handshake parameters.
2705 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2706 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002707 *
2708 * \warning MD5 is considered a weak message digest and its use constitutes a
2709 * security risk. If possible, we recommend avoiding dependencies on
2710 * it, and considering stronger message digests instead.
2711 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002714
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002717 *
2718 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002719 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002720 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002721 *
2722 * Module: library/memory_buffer_alloc.c
2723 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002725 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002726 *
2727 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002730
2731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002733 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002734 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2735 *
Simon Butcherd567a232016-03-09 20:19:21 +00002736 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2737 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002738 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002739 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002740 * \note See also our Knowledge Base article about porting to a new
2741 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002742 * 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 +00002743 *
Andres AG788aa4a2016-09-14 14:32:09 +01002744 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002745 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002746 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002749
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002752 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002753 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002754 *
2755 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002756 * Caller: library/asn1write.c
2757 * library/pkcs5.c
2758 * library/pkparse.c
2759 * library/pkwrite.c
2760 * library/rsa.c
2761 * library/x509.c
2762 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002763 * library/x509_crl.c
2764 * library/x509_crt.c
2765 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002766 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002767 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002768 *
2769 * This modules translates between OIDs and internal values.
2770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002772
2773/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002775 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002776 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002777 *
2778 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002779 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002780 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002781 * library/x509_crl.c
2782 * library/x509_crt.c
2783 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002786 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2787 *
2788 * \warning When parsing password-protected files, if MD5 is provided only by
2789 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002790 *
Paul Bakkercff68422013-09-15 20:43:33 +02002791 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002794
2795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002797 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002798 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002799 *
2800 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002801 * Caller: library/pkwrite.c
2802 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002803 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002804 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002806 *
2807 * This modules adds support for encoding / writing PEM files.
2808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002809#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002810
2811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002813 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002814 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002815 *
2816 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002817 * Caller: library/psa_crypto_rsa.c
2818 * library/ssl_tls.c
2819 * library/ssl*_client.c
2820 * library/ssl*_server.c
2821 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002822 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002823 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002824 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002825 * Uncomment to enable generic public key wrappers.
2826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002828
2829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002831 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002832 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002833 *
2834 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002835 * Caller: library/x509_crt.c
2836 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002837 *
Yanray Wang072a0682023-12-05 10:53:04 +08002838 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002839 *
2840 * Uncomment to enable generic public key parse functions.
2841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002843
2844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002846 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002847 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002848 *
2849 * Module: library/pkwrite.c
2850 * Caller: library/x509write.c
2851 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08002852 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002853 *
2854 * Uncomment to enable generic public key write functions.
2855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002857
2858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002859 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002861 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002862 *
2863 * Module: library/pkcs5.c
2864 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002865 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002866 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002867 * \warning If using a hash that is only provided by PSA drivers, you must
2868 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002869 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002870 * This module adds support for the PKCS#5 functions.
2871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002873
2874/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002875 * \def MBEDTLS_PKCS7_C
2876 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002877 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002878 * RFC Link - https://tools.ietf.org/html/rfc2315
2879 *
2880 * Module: library/pkcs7.c
2881 *
2882 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002883 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2884 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002885 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002886 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002887 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002888#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002889
2890/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002891 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002892 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002893 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002894 * Adds algorithms for parsing PKCS#8 encrypted private keys
2895 *
2896 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002897 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002898 *
Valerio Settie98ad592023-12-28 10:42:12 +01002899 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
2900 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002901 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002902 * \warning If using a hash that is only provided by PSA drivers, you must
2903 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002904 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002905 * This module enables PKCS#12 functions.
2906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002908
2909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002910 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002911 *
2912 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002913 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002914 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2916 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002917 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002918 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002919 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002920 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002921 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002922 * Module: library/platform.c
2923 * Caller: Most other .c files
2924 *
2925 * This module enables abstraction of common (libc) functions.
2926 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002927#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002928
2929/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002930 * \def MBEDTLS_POLY1305_C
2931 *
2932 * Enable the Poly1305 MAC algorithm.
2933 *
2934 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002935 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002936 */
2937#define MBEDTLS_POLY1305_C
2938
2939/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002940 * \def MBEDTLS_PSA_CRYPTO_C
2941 *
2942 * Enable the Platform Security Architecture cryptography API.
2943 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002944 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002945 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002946 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002947 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01002948 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
2949 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
2950 * is enabled in PSA (unless it's fully accelerated, see
2951 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01002952 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002953#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002954
2955/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002956 * \def MBEDTLS_PSA_CRYPTO_SE_C
2957 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002958 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002959 * cryptography API.
2960 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002961 * \deprecated This feature is deprecated. Please switch to the PSA driver
2962 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002963 *
Ryan Everett32a64582024-03-05 18:16:18 +00002964 * \warning This feature is not thread-safe, and should not be used in a
2965 * multi-threaded environment.
2966 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002967 * Module: library/psa_crypto_se.c
2968 *
2969 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2970 *
2971 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002972//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002973
2974/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002975 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2976 *
2977 * Enable the Platform Security Architecture persistent key storage.
2978 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002979 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002980 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002981 * Requires: MBEDTLS_PSA_CRYPTO_C,
2982 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2983 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002984 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002985#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002986
2987/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002988 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002989 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002990 * Enable the emulation of the Platform Security Architecture
2991 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002992 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002993 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002994 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002995 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002996 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002997#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002998
2999/**
Valerio Setti678e0fb2024-06-14 07:49:05 +02003000 * \def MBEDTLS_PSA_STATIC_KEY_SLOTS
3001 *
Valerio Setti933b7692024-08-13 11:08:26 +02003002 * Statically preallocate memory to store keys' material in PSA instead
3003 * of allocating it dynamically when required. This allows builds without a
3004 * heap, if none of the enabled cryptographic implementations or other features
3005 * require it.
3006 * This feature affects both volatile and persistent keys which means that
3007 * it's not possible to persistently store a key which is larger than
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003008 * #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE.
Valerio Setti678e0fb2024-06-14 07:49:05 +02003009 *
3010 * \note This feature comes with a (potentially) higher RAM usage since:
Valerio Setti83778d72024-10-04 13:46:37 +02003011 * - All the key slots are allocated no matter if they are used or not.
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003012 * - Each key buffer's length is #MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE bytes.
Valerio Setti678e0fb2024-06-14 07:49:05 +02003013 *
3014 * Requires: MBEDTLS_PSA_CRYPTO_C
3015 *
3016 */
3017//#define MBEDTLS_PSA_STATIC_KEY_SLOTS
3018
3019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003021 *
3022 * Enable the RIPEMD-160 hash algorithm.
3023 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003024 * Module: library/ripemd160.c
3025 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003026 *
3027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003029
3030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003032 *
3033 * Enable the RSA public-key cryptosystem.
3034 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003035 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003036 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003037 * Caller: library/pk.c
3038 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003039 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003040 * library/ssl*_client.c
3041 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003042 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003043 * This module is used by the following key exchanges:
Gilles Peskineb3ec1252024-09-20 18:22:04 +02003044 * RSA, DHE-RSA, ECDHE-RSA
Paul Bakker5690efc2011-05-26 13:16:06 +00003045 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003047 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003049
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003052 *
3053 * Enable the SHA1 cryptographic hash algorithm.
3054 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003055 * Module: library/sha1.c
3056 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003057 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003059 * This module is required for TLS 1.2 depending on the handshake parameters,
3060 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003061 *
3062 * \warning SHA-1 is considered a weak message digest and its use constitutes
3063 * a security risk. If possible, we recommend avoiding dependencies
3064 * on it, and considering stronger message digests instead.
3065 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003068
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003070 * \def MBEDTLS_SHA224_C
3071 *
3072 * Enable the SHA-224 cryptographic hash algorithm.
3073 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003074 * Module: library/sha256.c
3075 * Caller: library/md.c
3076 * library/ssl_cookie.c
3077 *
3078 * This module adds support for SHA-224.
3079 */
3080#define MBEDTLS_SHA224_C
3081
3082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003084 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003085 * Enable the SHA-256 cryptographic hash algorithm.
3086 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003087 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003088 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003089 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003090 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003091 * library/ssl*_client.c
3092 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003093 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003094 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003095 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003099/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003100 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003101 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003102 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3103 * with the ARMv8 cryptographic extensions if they are available at runtime.
3104 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003105 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003106 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003107 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003108 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003109 * \note Minimum compiler versions for this feature are Clang 4.0,
3110 * armclang 6.6 or GCC 6.0.
3111 *
3112 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3113 * armclang <= 6.9
3114 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003115 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3116 * That name is deprecated, but may still be used as an alternative form for this
3117 * option.
3118 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003119 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3120 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003121 *
3122 * Requires: MBEDTLS_SHA256_C.
3123 *
3124 * Module: library/sha256.c
3125 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003126 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003127 * and use them if available.
3128 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003129//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003130
Dave Rodgmand85277c2023-10-13 09:22:54 +01003131/**
3132 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3133 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003134 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003135 * This name is now deprecated, but may still be used as an alternative form for
3136 * this option.
3137 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003138//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3139
3140/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003141 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003142 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003143 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3144 * with the ARMv8 cryptographic extensions, which must be available at runtime
3145 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003146 *
3147 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003148 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003149 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003150 * \note Minimum compiler versions for this feature are Clang 4.0,
3151 * armclang 6.6 or GCC 6.0.
3152 *
3153 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3154 * armclang <= 6.9
3155 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003156 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003157 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003158 * option.
3159 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003160 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3161 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003162 *
3163 * Requires: MBEDTLS_SHA256_C.
3164 *
3165 * Module: library/sha256.c
3166 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003167 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003168 * unconditionally.
3169 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003170//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003171
Dave Rodgmand85277c2023-10-13 09:22:54 +01003172/**
3173 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3174 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003175 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003176 * This name is now deprecated, but may still be used as an alternative form for
3177 * this option.
3178 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3180
3181/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003182 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003183 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003184 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003185 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003186 * Module: library/sha512.c
3187 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003188 * library/psa_crypto_hash.c
3189 * library/ssl_tls.c
3190 * library/ssl*_client.c
3191 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003192 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003193 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003194 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003195#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003196
3197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003199 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003200 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003201 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003202 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003203 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003204 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003205 * library/ssl_tls.c
3206 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003207 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003208 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003211
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003212/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003213 * \def MBEDTLS_SHA3_C
3214 *
3215 * Enable the SHA3 cryptographic hash algorithm.
3216 *
3217 * Module: library/sha3.c
3218 *
3219 * This module adds support for SHA3.
3220 */
3221#define MBEDTLS_SHA3_C
3222
3223/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003224 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3225 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003226 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3227 * with the ARMv8 cryptographic extensions if they are available at runtime.
3228 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003229 *
3230 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3231 * for a non-Aarch64 build it will be silently ignored.
3232 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003233 * \note Minimum compiler versions for this feature are Clang 7.0,
3234 * armclang 6.9 or GCC 8.0.
3235 *
3236 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3237 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003238 *
3239 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3240 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3241 *
3242 * Requires: MBEDTLS_SHA512_C.
3243 *
3244 * Module: library/sha512.c
3245 *
3246 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3247 * and use them if available.
3248 */
3249//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3250
3251/**
3252 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3253 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003254 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3255 * with the ARMv8 cryptographic extensions, which must be available at runtime
3256 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003257 *
3258 * \note This allows builds with a smaller code size than with
3259 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3260 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003261 * \note Minimum compiler versions for this feature are Clang 7.0,
3262 * armclang 6.9 or GCC 8.0.
3263 *
3264 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3265 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003266 *
3267 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3268 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3269 *
3270 * Requires: MBEDTLS_SHA512_C.
3271 *
3272 * Module: library/sha512.c
3273 *
3274 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3275 * unconditionally.
3276 */
3277//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3278
3279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003281 *
3282 * Enable simple SSL cache implementation.
3283 *
3284 * Module: library/ssl_cache.c
3285 * Caller:
3286 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003290
3291/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003293 *
3294 * Enable basic implementation of DTLS cookies for hello verification.
3295 *
3296 * Module: library/ssl_cookie.c
3297 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003300
3301/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003302 * \def MBEDTLS_SSL_TICKET_C
3303 *
3304 * Enable an implementation of TLS server-side callbacks for session tickets.
3305 *
3306 * Module: library/ssl_ticket.c
3307 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003308 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003309 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3310 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003311 */
3312#define MBEDTLS_SSL_TICKET_C
3313
3314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003316 *
3317 * Enable the SSL/TLS client code.
3318 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003319 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003320 * Caller:
3321 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003323 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003324 * This module is required for SSL/TLS client support.
3325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003327
Paul Bakker9a736322012-11-14 12:39:52 +00003328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003330 *
3331 * Enable the SSL/TLS server code.
3332 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003333 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003334 * Caller:
3335 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003337 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003338 * This module is required for SSL/TLS server support.
3339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003341
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003344 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003345 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003346 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003347 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003348 * Caller: library/ssl*_client.c
3349 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003350 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3352 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003353 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003354 * This module is required for SSL/TLS.
3355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003357
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003360 *
3361 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003362 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003363 * contexts are not shared between threads. If you do intend to use contexts
3364 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003365 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003366 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003367 *
3368 * Module: library/threading.c
3369 *
3370 * This allows different threading implementations (self-implemented or
3371 * provided).
3372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * You will have to enable either MBEDTLS_THREADING_ALT or
3374 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003375 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003376 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003379
3380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003382 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003383 * Enable the semi-portable timing interface.
3384 *
Simon Butcherd567a232016-03-09 20:19:21 +00003385 * \note The provided implementation only works on POSIX/Unix (including Linux,
3386 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003387 * module and provide your own implementations of the callbacks needed by
3388 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3389 * your own implementation of the whole module by setting
3390 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003391 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003392 * \note The timing module will include time.h on suitable platforms
3393 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3394 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3395 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003396 * \note See also our Knowledge Base article about porting to a new
3397 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003398 * 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 +00003399 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003400 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003403
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003404/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003406 *
3407 * Enable run-time version information.
3408 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003409 * Module: library/version.c
3410 *
3411 * This module provides run-time version information.
3412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003414
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003417 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003418 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003419 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003421 * Caller: library/x509_crl.c
3422 * library/x509_crt.c
3423 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003425 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003426 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3427 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003428 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3429 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003430 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003431 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003434
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003435/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003436 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003437 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003438 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003439 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003440 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003441 * Caller: library/ssl_tls.c
3442 * library/ssl*_client.c
3443 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003444 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003446 *
3447 * This module is required for X.509 certificate parsing.
3448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003450
3451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453 *
3454 * Enable X.509 CRL parsing.
3455 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003456 * Module: library/x509_crl.c
3457 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003458 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003460 *
3461 * This module is required for X.509 CRL parsing.
3462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003463#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003464
3465/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003466 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003467 *
3468 * Enable X.509 Certificate Signing Request (CSR) parsing.
3469 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003470 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003471 * Caller: library/x509_crt_write.c
3472 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003474 *
3475 * This module is used for reading X.509 certificate request.
3476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003478
3479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003482 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003483 *
3484 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003485 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003486 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003487 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3488 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003489 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3490 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003491 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003492 * This module is the basis for creating X.509 certificates and CSRs.
3493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003495
3496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003498 *
3499 * Enable creating X.509 certificates.
3500 *
3501 * Module: library/x509_crt_write.c
3502 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003504 *
3505 * This module is required for X.509 certificate creation.
3506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003508
3509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003511 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003512 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003513 *
3514 * Module: library/x509_csr_write.c
3515 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003517 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003518 * This module is required for X.509 certificate request writing.
3519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003521
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003522/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003523
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003524/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003525 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003526 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003527 * This section contains Mbed TLS build settings that are not associated
3528 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003529 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003530 * \{
3531 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003532
Gilles Peskinea02c1242022-03-16 17:03:19 +01003533/**
3534 * \def MBEDTLS_CONFIG_FILE
3535 *
3536 * If defined, this is a header which will be included instead of
3537 * `"mbedtls/mbedtls_config.h"`.
3538 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003539 * Unlike other configuration options, this one must be defined on the
3540 * compiler command line: a definition in `mbedtls_config.h` would have
3541 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003542 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003543 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003544 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003545 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003546 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003547 * The value of this symbol is typically a path in double quotes, either
3548 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003549 */
3550//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3551
3552/**
3553 * \def MBEDTLS_USER_CONFIG_FILE
3554 *
3555 * If defined, this is a header which will be included after
3556 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003557 * This allows you to modify the default configuration, including the ability
3558 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003559 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003560 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003561 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003562 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003563 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003564 * The value of this symbol is typically a path in double quotes, either
3565 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003566 */
3567//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3568
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003569/**
3570 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3571 *
3572 * If defined, this is a header which will be included instead of
3573 * `"psa/crypto_config.h"`.
3574 * This header file specifies which cryptographic mechanisms are available
3575 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3576 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3577 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003578 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003579 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003580 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003581 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003582 * The value of this symbol is typically a path in double quotes, either
3583 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003584 */
3585//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3586
3587/**
3588 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3589 *
3590 * If defined, this is a header which will be included after
3591 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003592 * This allows you to modify the default configuration, including the ability
3593 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003594 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003595 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003596 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003597 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003598 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003599 * The value of this symbol is typically a path in double quotes, either
3600 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003601 */
3602//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3603
Gilles Peskineb1176f22023-02-22 22:07:28 +01003604/**
3605 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3606 *
3607 * If defined, this is a header which will be included instead of
3608 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3609 * as the one in Mbed TLS, but with definitions adapted to the platform on
3610 * which the library code will run.
3611 *
3612 * \note The required content of this header can vary from one version of
3613 * Mbed TLS to the next. Integrators who provide an alternative file
3614 * should review the changes in the original file whenever they
3615 * upgrade Mbed TLS.
3616 *
3617 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3618 * non-standard feature of the C language, so this feature is only available
3619 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3620 *
3621 * The value of this symbol is typically a path in double quotes, either
3622 * absolute or relative to a directory on the include search path.
3623 */
3624//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3625
3626/**
3627 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3628 *
3629 * If defined, this is a header which will be included instead of
3630 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3631 * as the one in Mbed TLS, but with definitions adapted to the environment
3632 * in which the library code will run. The typical use for this feature
3633 * is to provide alternative type definitions on the client side in
3634 * client-server integrations of PSA crypto, where operation structures
3635 * contain handles instead of cryptographic data.
3636 *
3637 * \note The required content of this header can vary from one version of
3638 * Mbed TLS to the next. Integrators who provide an alternative file
3639 * should review the changes in the original file whenever they
3640 * upgrade Mbed TLS.
3641 *
3642 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3643 * non-standard feature of the C language, so this feature is only available
3644 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3645 *
3646 * The value of this symbol is typically a path in double quotes, either
3647 * absolute or relative to a directory on the include search path.
3648 */
3649//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3650
Gilles Peskineba4162a2022-04-11 17:04:38 +02003651/** \} name SECTION: General configuration options */
3652
3653/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003654 * \name SECTION: Module configuration options
3655 *
3656 * This section allows for the setting of module specific sizes and
3657 * configuration options. The default values are already present in the
3658 * relevant header files and should suffice for the regular use cases.
3659 *
3660 * Our advice is to enable options and change their values here
3661 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003662 * \{
3663 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003664/* The Doxygen documentation here is used when a user comments out a
3665 * setting and runs doxygen themselves. On the other hand, when we typeset
3666 * the full documentation including disabled settings, the documentation
3667 * in specific modules' header files is used if present. When editing this
3668 * file, make sure that each option is documented in exactly one place,
3669 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3670 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003671
Paul Bakker088c5c52014-04-25 11:11:10 +02003672/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003673//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003675
Paul Bakker088c5c52014-04-25 11:11:10 +02003676/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003677//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3678//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3679//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3680//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3681//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003682
Paul Bakker088c5c52014-04-25 11:11:10 +02003683/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003684//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3685//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3686//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3687//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003688
Paul Bakker088c5c52014-04-25 11:11:10 +02003689/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003690//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003691//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003692
Paul Bakker088c5c52014-04-25 11:11:10 +02003693/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3695//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003696//#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 +01003697
Paul Bakker088c5c52014-04-25 11:11:10 +02003698/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003699//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003700
Paul Bakker088c5c52014-04-25 11:11:10 +02003701/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003702//#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 -04003703
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003704/** \def MBEDTLS_PLATFORM_STD_CALLOC
3705 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003706 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003707 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003708 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003709 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003710 * 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 -04003711 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3712 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003713 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003714 */
3715//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003716
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003717/** \def MBEDTLS_PLATFORM_STD_FREE
3718 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003719 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003720 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003721 * 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 -04003722 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3723 * 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 -04003724 */
3725//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003726//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003728//#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 +02003729//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3730//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003731/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003732//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003733//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3734//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003735//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3736//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3737//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003738
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003739/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003740/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003741//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3742//#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 +02003743//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003744//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003745//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3746//#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 +02003747//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3748//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003749/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003750//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003751//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003752//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3753//#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 +08003754//#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 +08003755//#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 +02003756
Gilles Peskine3f106f72021-09-23 17:42:39 +02003757/** \def MBEDTLS_CHECK_RETURN
3758 *
3759 * This macro is used at the beginning of the declaration of a function
3760 * to indicate that its return value should be checked. It should
3761 * instruct the compiler to emit a warning or an error if the function
3762 * is called without checking its return value.
3763 *
3764 * There is a default implementation for popular compilers in platform_util.h.
3765 * You can override the default implementation by defining your own here.
3766 *
3767 * If the implementation here is empty, this will effectively disable the
3768 * checking of functions' return values.
3769 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003770//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003771
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003772/** \def MBEDTLS_IGNORE_RETURN
3773 *
3774 * This macro requires one argument, which should be a C function call.
3775 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3776 * warning is suppressed.
3777 */
3778//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3779
Gilles Peskineed038902020-11-13 21:33:21 +01003780/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003781/**
Gilles Peskineed038902020-11-13 21:33:21 +01003782 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3783 * PSA crypto subsystem.
3784 *
Gilles Peskine868d2522024-07-01 21:14:45 +02003785 * If this option is unset, the library chooses a hash (currently between
3786 * #MBEDTLS_MD_SHA512 and #MBEDTLS_MD_SHA256) based on availability and
3787 * unspecified heuristics.
3788 *
3789 * \note The PSA crypto subsystem uses the first available mechanism amongst
3790 * the following:
3791 * - #MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG if enabled;
3792 * - Entropy from #MBEDTLS_ENTROPY_C plus CTR_DRBG with AES
3793 * if #MBEDTLS_CTR_DRBG_C is enabled;
3794 * - Entropy from #MBEDTLS_ENTROPY_C plus HMAC_DRBG.
3795 *
3796 * A future version may reevaluate the prioritization of DRBG mechanisms.
Gilles Peskineed038902020-11-13 21:33:21 +01003797 */
3798//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3799
Steven Cooreman863470a2021-02-15 14:03:19 +01003800/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003801 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003802 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is disabled,
3803 * the maximum amount of PSA keys simultaneously in memory. This counts all
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003804 * volatile keys, plus loaded persistent keys.
3805 *
Gilles Peskine9e9e1f62024-05-31 18:38:36 +02003806 * When #MBEDTLS_PSA_KEY_STORE_DYNAMIC is enabled,
3807 * the maximum number of loaded persistent keys.
3808 *
Gilles Peskine2cb03a52024-07-16 21:29:13 +02003809 * Currently, persistent keys do not need to be loaded all the time while
3810 * a multipart operation is in progress, only while the operation is being
3811 * set up. This may change in future versions of the library.
3812 *
3813 * Currently, the library traverses of the whole table on each access to a
3814 * persistent key. Therefore large values may cause poor performance.
3815 *
3816 * This option has no effect when #MBEDTLS_PSA_CRYPTO_C is disabled.
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003817 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003818//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003819
Valerio Settia7ce5892024-08-13 10:44:02 +02003820/**
Valerio Setti933b7692024-08-13 11:08:26 +02003821 * \def MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE
Valerio Settia7ce5892024-08-13 10:44:02 +02003822 *
Valerio Settic2a6e8b2024-08-16 07:58:02 +02003823 * Define the size (in bytes) of each static key buffer when
3824 * #MBEDTLS_PSA_STATIC_KEY_SLOTS is set. If not
3825 * explicitly defined then it's automatically guessed from available PSA keys
3826 * enabled in the build through PSA_WANT_xxx symbols.
Valerio Settia7ce5892024-08-13 10:44:02 +02003827 * If required by the application this parameter can be set to higher values
3828 * in order to store larger objects (ex: raw keys), but please note that this
3829 * will increase RAM usage.
Valerio Settia7ce5892024-08-13 10:44:02 +02003830 */
3831//#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 256
3832
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00003833/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02003834//#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 +00003835
Paul Bakker088c5c52014-04-25 11:11:10 +02003836/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003837//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3838//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003839
Paul Bakker088c5c52014-04-25 11:11:10 +02003840/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003841
Angus Grattond8213d02016-05-25 20:56:48 +10003842/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3843 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003844 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003845 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003846 * This determines the size of the incoming TLS I/O buffer in such a way
3847 * that it is capable of holding the specified amount of plaintext data,
3848 * regardless of the protection mechanism used.
3849 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003850 * \note When using a value less than the default of 16KB on the client, it is
3851 * recommended to use the Maximum Fragment Length (MFL) extension to
3852 * inform the server about this limitation. On the server, there
3853 * is no supported, standardized way of informing the client about
3854 * restriction on the maximum size of incoming messages, and unless
3855 * the limitation has been communicated by other means, it is recommended
3856 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3857 * while keeping the default value of 16KB for the incoming buffer.
3858 *
David Horstmann95d516f2021-05-04 18:36:56 +01003859 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003860 */
3861//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3862
Gilles Peskined3d02902020-03-04 21:35:27 +01003863/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3864 *
3865 * The maximum length of CIDs used for incoming DTLS messages.
3866 *
3867 */
3868//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3869
3870/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3871 *
3872 * The maximum length of CIDs used for outgoing DTLS messages.
3873 *
3874 */
3875//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3876
TRodziewicze8dd7092021-05-12 14:19:11 +02003877/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003878 *
3879 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003880 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003881 *
3882 * The padding will always be chosen so that the length of the
3883 * padded plaintext is a multiple of the value of this option.
3884 *
3885 * Note: A value of \c 1 means that no padding will be used
3886 * for outgoing records.
3887 *
3888 * Note: On systems lacking division instructions,
3889 * a power of two should be preferred.
3890 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003891//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003892
Angus Grattond8213d02016-05-25 20:56:48 +10003893/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3894 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003895 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003896 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003897 * This determines the size of the outgoing TLS I/O buffer in such a way
3898 * that it is capable of holding the specified amount of plaintext data,
3899 * regardless of the protection mechanism used.
3900 *
Angus Grattond8213d02016-05-25 20:56:48 +10003901 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3902 * the default inward 16384 byte buffer to conform to the TLS specification.
3903 *
3904 * The minimum required outward buffer size is determined by the handshake
3905 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3906 * The specific size requirement depends on the configured ciphers and any
3907 * certificate data which is sent during the handshake.
3908 *
David Horstmann95d516f2021-05-04 18:36:56 +01003909 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003910 */
3911//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3912
Hanno Beckere0b150f2018-08-21 15:51:03 +01003913/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3914 *
3915 * Maximum number of heap-allocated bytes for the purpose of
3916 * DTLS handshake message reassembly and future message buffering.
3917 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003918 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003919 * to account for a reassembled handshake message of maximum size,
3920 * together with its reassembly bitmap.
3921 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003922 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003923 * should be sufficient for all practical situations as it allows
3924 * to reassembly a large handshake message (such as a certificate)
3925 * while buffering multiple smaller handshake messages.
3926 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003927 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003928//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003929
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003930//#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 +02003931//#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 +02003932
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003933/**
3934 * Complete list of ciphersuites to use, in order of preference.
3935 *
3936 * \warning No dependency checking is done on that field! This option can only
3937 * be used to restrict the set of available ciphersuites. It is your
3938 * responsibility to make sure the needed modules are active.
3939 *
3940 * Use this to save a few hundred bytes of ROM (default ordering of all
3941 * available ciphersuites) and a few to a few hundred bytes of RAM.
3942 *
3943 * The value below is only an example, not the default.
3944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003945//#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 +02003946
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003947/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003948 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
3949 *
3950 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08003951 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003952 *
3953 * It must be positive and smaller than UINT32_MAX.
3954 *
3955 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
3956 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01003957 */
3958//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
3959
3960/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003961 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3962 *
Jerry Yucf913512023-11-14 11:06:52 +08003963 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08003964 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003965 *
Jerry Yu034a8b72023-11-10 12:20:19 +08003966 * - The client ticket age is the time difference between the time when the
3967 * client proposes to the server to use the ticket and the time the client
3968 * received the ticket from the server.
3969 * - The server ticket age is the time difference between the time when the
3970 * server receives a proposition from the client to use the ticket and the
3971 * time when the ticket was created by the server.
3972 *
Jerry Yucf913512023-11-14 11:06:52 +08003973 * The ages might be different due to the client and server clocks not running
3974 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
3975 * per million (360 to 72 milliseconds per hour). Default tolerance window is
3976 * 6s, thus in the worst case clients and servers must sync up their system time
3977 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003978 *
Jerry Yu04fceb72023-11-15 09:52:46 +08003979 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003980 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003981//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003982
3983/**
3984 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3985 *
3986 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3987 *
3988 * This must be less than 256.
3989 */
Gilles Peskined65ea422023-09-05 21:07:32 +02003990//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003991
3992/**
3993 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3994 *
3995 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3996 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3997 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3998 *
3999 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004000//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004001
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004002/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004003//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004004//#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 +01004005
Gilles Peskine611179c2022-04-13 23:04:48 +02004006/** \} name SECTION: Module configuration options */