blob: 2c82ca369edd9e8fed655e7b2a5ca48aa61958de [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +000012 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020013 */
14
Bence Szépkúti2bb74562021-06-21 16:19:00 +020015/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010016 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020017 * config files.
18 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010019 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020020 * introduced the config format we want to be compatible with.
21 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020022//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020023
Paul Bakkerf3b86c12011-01-27 15:24:17 +000024/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000025 * \name SECTION: System support
26 *
27 * This section sets system specific settings.
28 * \{
29 */
30
Paul Bakkerf3b86c12011-01-27 15:24:17 +000031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000033 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020034 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000035 *
36 * Requires support for asm() in compiler.
37 *
38 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000039 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010040 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000041 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000042 * library/constant_time.c
Paul Bakker68041ec2009-04-19 21:17:55 +000043 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010044 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000045 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010046 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010047 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020048 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020050#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000051
Paul Bakkerf3b86c12011-01-27 15:24:17 +000052/**
Gilles Peskineed942f82017-06-08 15:19:20 +020053 * \def MBEDTLS_NO_UDBL_DIVISION
54 *
55 * The platform lacks support for double-width integer division (64-bit
56 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
57 *
58 * Used in:
59 * include/mbedtls/bignum.h
60 * library/bignum.c
61 *
62 * The bignum code uses double-width division to speed up some operations.
63 * Double-width division is often implemented in software that needs to
64 * be linked with the program. The presence of a double-width integer
65 * type is usually detected automatically through preprocessor macros,
66 * but the automatic detection cannot know whether the code needs to
67 * and can be linked with an implementation of division for that type.
68 * By default division is assumed to be usable if the type is present.
69 * Uncomment this option to prevent the use of double-width division.
70 *
71 * Note that division for the native integer type is always required.
72 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010073 * platform, but it need not support multiplication or division. In some
74 * cases it is also desirable to disable some double-width operations. For
75 * example, if double-width division is implemented in software, disabling
76 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020077 */
78//#define MBEDTLS_NO_UDBL_DIVISION
79
80/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020081 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
82 *
83 * The platform lacks support for 32x32 -> 64-bit multiplication.
84 *
85 * Used in:
86 * library/poly1305.c
87 *
88 * Some parts of the library may use multiplication of two unsigned 32-bit
89 * operands with a 64-bit result in order to speed up computations. On some
90 * platforms, this is not available in hardware and has to be implemented in
91 * software, usually in a library provided by the toolchain.
92 *
93 * Sometimes it is not desirable to have to link to that library. This option
94 * removes the dependency of that library on platforms that lack a hardware
95 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
96 *
97 * Note that depending on the compiler, this may decrease performance compared
98 * to using the library function provided by the toolchain.
99 */
100//#define MBEDTLS_NO_64BIT_MULTIPLICATION
101
102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000104 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000105 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000106 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200109//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200110
111/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200112 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200113 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200114 * System has time.h and time().
115 * The time does not need to be correct, only time differences are used,
116 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200117 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100118 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
119 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
120 * MBEDTLS_PLATFORM_STD_TIME.
121 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400122 * Comment if your system does not support time functions.
123 *
124 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
125 * interface - timing.c will include time.h on suitable platforms
126 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
127 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100130
131/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200132 * \def MBEDTLS_HAVE_TIME_DATE
133 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100134 * System has time.h, time(), and an implementation for
135 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100136 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200137 * the date should be correct). This is used to verify the validity period of
138 * X.509 certificates.
139 *
140 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100141 *
Hanno Becker6a739782018-09-05 15:06:19 +0100142 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100143 * behaves similarly to the gmtime_r() function from the C standard. Refer to
144 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100145 *
146 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100147 * mbedtls_platform_gmtime_r() at compile-time by using the macro
148 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200149 */
150#define MBEDTLS_HAVE_TIME_DATE
151
152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100154 *
155 * Enable the memory allocation layer.
156 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200157 * By default Mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100158 * This allows different allocators (self-implemented or provided) to be
159 * provided to the platform abstraction layer.
160 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400161 * Enabling #MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200162 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
163 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000164 * free() function pointer at runtime.
165 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400166 * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000168 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100169 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -0400170 * An overview of how the value of mbedtls_calloc is determined:
171 *
172 * - if !MBEDTLS_PLATFORM_MEMORY
173 * - mbedtls_calloc = calloc
174 * - if MBEDTLS_PLATFORM_MEMORY
175 * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
176 * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO
177 * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO):
178 * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC.
179 * - How is MBEDTLS_PLATFORM_STD_CALLOC handled?
180 * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
181 * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything;
182 * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present;
183 * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS:
184 * - if MBEDTLS_PLATFORM_STD_CALLOC is present:
185 * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected;
186 * - if !MBEDTLS_PLATFORM_STD_CALLOC:
187 * - MBEDTLS_PLATFORM_STD_CALLOC = calloc
188 *
189 * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked.
190 * - if !MBEDTLS_PLATFORM_STD_CALLOC
191 * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc
192 *
193 * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC.
194 *
195 * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible.
196 * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time.
197 * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used,
198 * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases.
199 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
200 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100203 *
204 * Enable this layer to allow use of alternative memory allocators.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100207
208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200209 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200210 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200211 * Do not assign standard functions in the platform layer (e.g. calloc() to
212 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200213 *
214 * This makes sure there are no linking errors on platforms that do not support
215 * these functions. You will HAVE to provide alternatives, either at runtime
216 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
218 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200220 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200221 *
222 * Uncomment to prevent default assignment of standard functions in the
223 * platform layer.
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200226
227/**
Janos Follathc351d182016-03-21 08:43:59 +0000228 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200230 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100231 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100232 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200233 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100235 * alternative printf function pointer.
236 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100238 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200239 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
240 * it will be enabled automatically by check_config.h
241 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200242 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000244 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100245 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
246 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100247 * Uncomment a macro to enable alternate implementation of specific base
248 * platform function
249 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200250//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100252//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253//#define MBEDTLS_PLATFORM_FPRINTF_ALT
254//#define MBEDTLS_PLATFORM_PRINTF_ALT
255//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200256//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100257//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100258//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800259//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260
261/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200262 * Uncomment the macro to let Mbed TLS use your alternate implementation of
263 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
264 * platform_util.c.
265 *
266 * gmtime() is not a thread-safe function as defined in the C standard. The
267 * library will try to use safer implementations of this function, such as
268 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
269 * system, the implementation of mbedtls_platform_gmtime_r() will default to
270 * using the standard gmtime(). In this case, calls from the library to
271 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
272 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
273 * library are also guarded with this mutex to avoid race conditions. However,
274 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
275 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
276 * supplied at compile time.
277 */
278//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
279
280/**
Gilles Peskine86733832023-09-07 15:02:39 +0200281 * Uncomment the macro to let Mbed TLS use your alternate implementation of
282 * mbedtls_platform_zeroize(), to wipe sensitive data in memory. This replaces
283 * the default implementation in platform_util.c.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200284 *
Gilles Peskine86733832023-09-07 15:02:39 +0200285 * By default, the library uses a system function such as memset_s()
286 * (optional feature of C11), explicit_bzero() (BSD and compatible), or
287 * SecureZeroMemory (Windows). If no such function is detected, the library
288 * falls back to a plain C implementation. Compilers are technically
289 * permitted to optimize this implementation out, meaning that the memory is
290 * not actually wiped. The library tries to prevent that, but the C language
291 * makes it impossible to guarantee that the memory will always be wiped.
292 *
293 * If your platform provides a guaranteed method to wipe memory which
294 * `platform_util.c` does not detect, define this macro to the name of
295 * a function that takes two arguments, a `void *` pointer and a length,
296 * and wipes that many bytes starting at the specified address. For example,
297 * if your platform has explicit_bzero() but `platform_util.c` does not
298 * detect its presence, define `MBEDTLS_PLATFORM_ZEROIZE_ALT` to be
299 * `explicit_bzero` to use that function as mbedtls_platform_zeroize().
Gilles Peskinea8861e02023-09-05 20:20:51 +0200300 */
301//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
302
303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100305 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000306 * Mark deprecated functions and features so that they generate a warning if
307 * used. Functionality deprecated in one version will usually be removed in the
308 * next version. You can enable this to help you prepare the transition to a
309 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100310 *
311 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100313 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000314 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100317
318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100320 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000321 * Remove deprecated functions and features so that they generate an error if
322 * used. Functionality deprecated in one version will usually be removed in the
323 * next version. You can enable this to help you prepare the transition to a
324 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100325 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000326 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100327 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100329
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100330/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000331
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000332/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200333 * \name SECTION: Mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000334 *
335 * This section sets support for features that are or are not needed
336 * within the modules that are enabled.
337 * \{
338 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100342 *
TRodziewiczd8540832021-06-10 15:16:50 +0200343 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200344 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100347 *
348 * You will need to provide a header "timing_alt.h" and an implementation at
349 * compile time.
350 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200351//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100352
353/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100354 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200355 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200356 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100357 * alternate core implementation of a symmetric crypto, an arithmetic or hash
358 * module (e.g. platform specific assembly optimized implementations). Keep
359 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200360 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200364 * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000365 * provide the "struct mbedtls_aes_context" definition and omit the base
366 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200367 * "aes.h" to include the new function definitions.
368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * use constitutes a security risk. If possible, we recommend
374 * avoiding dependencies on them, and considering stronger message
375 * digests and ciphers instead.
376 *
Paul Bakker90995b52013-06-24 19:20:35 +0200377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000379//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200381//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300382//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200383//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200384//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385//#define MBEDTLS_DES_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100386//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300387//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300389//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390//#define MBEDTLS_RIPEMD160_ALT
391//#define MBEDTLS_SHA1_ALT
392//#define MBEDTLS_SHA256_ALT
393//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000394
Janos Follathb0697532016-08-18 12:38:46 +0100395/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800396 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100397 * implemented with two .c files:
398 * - ecp.c
399 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000400 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
401 * macros as described above. The only difference is that you have to make sure
402 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100403 */
404//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200405
406/**
TRodziewicz75628d52021-06-18 12:56:27 +0200407 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200408 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200409 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100410 * alternate core implementation of symmetric crypto or hash function. Keep in
411 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200412 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200413 * This replaces only one function. The header file from Mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200414 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200415 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200416 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417 * no longer provide the mbedtls_sha1_process() function, but it will still provide
418 * the other function (using your mbedtls_sha1_process() function) and the definition
419 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200420 * with this definition.
421 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200422 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100423 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
424 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200425 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200426 * Uncomment a macro to enable alternate implementation of the corresponding
427 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100428 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200429 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100430 * constitutes a security risk. If possible, we recommend avoiding
431 * dependencies on them, and considering stronger message digests
432 * and ciphers instead.
433 *
Janos Follath1231d212019-01-07 15:01:32 +0000434 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
435 * enabled, then the deterministic ECDH signature functions pass the
436 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
437 * alternative implementations should use the RNG only for generating
438 * the ephemeral key and nothing else. If this is not possible, then
439 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200440 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000441 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443//#define MBEDTLS_MD5_PROCESS_ALT
444//#define MBEDTLS_RIPEMD160_PROCESS_ALT
445//#define MBEDTLS_SHA1_PROCESS_ALT
446//#define MBEDTLS_SHA256_PROCESS_ALT
447//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200448//#define MBEDTLS_DES_SETKEY_ALT
449//#define MBEDTLS_DES_CRYPT_ECB_ALT
450//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200451//#define MBEDTLS_AES_SETKEY_ENC_ALT
452//#define MBEDTLS_AES_SETKEY_DEC_ALT
453//#define MBEDTLS_AES_ENCRYPT_ALT
454//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300455//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300456//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300457//#define MBEDTLS_ECDSA_VERIFY_ALT
458//#define MBEDTLS_ECDSA_SIGN_ALT
459//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200460
461/**
Janos Follathc44ab972016-11-18 16:38:23 +0000462 * \def MBEDTLS_ECP_INTERNAL_ALT
463 *
464 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100465 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200466 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100467 * alternative core implementation of elliptic curve arithmetic. Keep in mind
468 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100469 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200470 * This partially replaces one function. The header file from Mbed TLS is still
Janos Follathb0697532016-08-18 12:38:46 +0100471 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
472 * is still present and it is used for group structures not supported by the
473 * alternative.
474 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100475 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100476 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100477 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
478 * able to fallback to curves not supported by the alternative implementation.
479 *
Janos Follathc44ab972016-11-18 16:38:23 +0000480 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
481 * and implementing the following functions:
482 * unsigned char mbedtls_internal_ecp_grp_capable(
483 * const mbedtls_ecp_group *grp )
484 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500485 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000486 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
487 * replacement functions implement arithmetic for the given group and 0
488 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500489 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000490 * called before and after each point operation and provide an opportunity to
491 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100492 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100493 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200494 * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac()
Steven Cooreman6226a122021-01-21 13:58:31 +0100495 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
496 * for the operation is supported by your implementation (i.e. your
497 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200498 * group is not supported by your implementation, then the original Mbed TLS
Steven Cooreman6226a122021-01-21 13:58:31 +0100499 * implementation of ecp_double_jac() is used instead, unless this fallback
500 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
501 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
502 *
503 * The function prototypes and the definition of mbedtls_ecp_group and
504 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
505 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
506 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100507 *
508 * Uncomment a macro to enable alternate implementation of the corresponding
509 * function.
510 */
511/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000512//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100513/* Turn off software fallback for curves not supported in hardware */
514//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100515/* Support for Weierstrass curves with Jacobi representation */
516//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
517//#define MBEDTLS_ECP_ADD_MIXED_ALT
518//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
519//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
520//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
521/* Support for curves with Montgomery arithmetic */
522//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
523//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
524//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
525
526/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200527 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200528 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +0200529 * Uncomment this macro to let Mbed TLS use your own implementation of a
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200530 * hardware entropy collector.
531 *
532 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000533 * prototype as declared in library/entropy_poll.h, and accept NULL as first
534 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200535 *
536 * Uncomment to use your own hardware entropy collector.
537 */
538//#define MBEDTLS_ENTROPY_HARDWARE_ALT
539
540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000542 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100543 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000544 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100545 * Uncomment this macro to use precomputed AES tables stored in ROM.
546 * Comment this macro to generate AES tables in RAM at runtime.
547 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100548 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
549 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100550 * initialization time before the first AES operation can be performed.
551 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
552 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
553 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100554 *
555 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000558
559/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100560 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200561 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200563 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100564 * Uncommenting this macro omits 75% of the AES tables from
565 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
566 * by computing their values on the fly during operations
567 * (the tables are entry-wise rotations of one another).
568 *
569 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100570 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 * runtime. Specifically, one has to compare 4 accesses within
572 * different tables to 4 accesses with additional arithmetic
573 * operations within the same table. The performance gain/loss
574 * depends on the system and memory details.
575 *
576 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200577 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100578//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200579
580/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800581 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
582 *
583 * Use only 128-bit keys in AES operations to save ROM.
584 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800585 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800586 * or 256-bit keys.
587 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800588 * Uncommenting this macro reduces the size of AES code by ~300 bytes
589 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800590 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800591 * Module: library/aes.c
592 *
593 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800594 */
595//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
596
Gilles Peskinea8861e02023-09-05 20:20:51 +0200597/*
598 * Disable plain C implementation for AES.
599 *
600 * When the plain C implementation is enabled, and an implementation using a
601 * special CPU feature (such as MBEDTLS_AESCE_C) is also enabled, runtime
602 * detection will be used to select between them.
603 *
604 * If only one implementation is present, runtime detection will not be used.
605 * This configuration will crash at runtime if running on a CPU without the
606 * necessary features. It will not build unless at least one of MBEDTLS_AESCE_C
607 * and/or MBEDTLS_AESNI_C is enabled & present in the build.
608 */
609//#define MBEDTLS_AES_USE_HARDWARE_ONLY
610
Arto Kinnunen732ca322023-04-14 14:26:10 +0800611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200613 *
614 * Use less ROM for the Camellia implementation (saves about 768 bytes).
615 *
616 * Uncomment this macro to use less memory for Camellia.
617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200619
620/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200621 * \def MBEDTLS_CHECK_RETURN_WARNING
622 *
623 * If this macro is defined, emit a compile-time warning if application code
624 * calls a function without checking its return value, but the return value
625 * should generally be checked in portable applications.
626 *
627 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
628 * implemented. Otherwise this option has no effect.
629 *
630 * Uncomment to get warnings on using fallible functions without checking
631 * their return value.
632 *
633 * \note This feature is a work in progress.
634 * Warnings will be added to more functions in the future.
635 *
636 * \note A few functions are considered critical, and ignoring the return
637 * value of these functions will trigger a warning even if this
638 * macro is not defined. To completely disable return value check
639 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
640 */
641//#define MBEDTLS_CHECK_RETURN_WARNING
642
643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200644 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200645 *
646 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200648#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200649
650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000652 *
653 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000656
657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200658 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000659 *
660 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000663
664/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100665 * \def MBEDTLS_CIPHER_MODE_OFB
666 *
667 * Enable Output Feedback mode (OFB) for symmetric ciphers.
668 */
669#define MBEDTLS_CIPHER_MODE_OFB
670
671/**
672 * \def MBEDTLS_CIPHER_MODE_XTS
673 *
674 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
675 */
676#define MBEDTLS_CIPHER_MODE_XTS
677
678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000680 *
681 * Enable NULL cipher.
682 * Warning: Only do so when you know what you are doing. This allows for
683 * encryption or channels without any security!
684 *
Ronald Croncee42702021-04-26 11:34:44 +0200685 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
687 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
688 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
689 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
690 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
691 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
692 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
693 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
694 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
695 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
696 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
697 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
698 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
699 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
700 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
701 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
702 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
703 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
704 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000705 *
706 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000709
710/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100711 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200712 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100713 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
714 * specific padding modes in the cipher layer with cipher modes that support
715 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200716 *
717 * If you disable all padding modes, only full blocks can be used with CBC.
718 *
719 * Enable padding modes in the cipher layer.
720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200721#define MBEDTLS_CIPHER_PADDING_PKCS7
722#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
723#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
724#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200725
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200726/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
727 *
728 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800729 * Without this, CTR_DRBG uses a 256-bit key
730 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200731 */
732//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
733
Paul Bakker48e93c82013-08-14 12:21:18 +0200734/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200735 * Enable the verified implementations of ECDH primitives from Project Everest
736 * (currently only Curve25519). This feature changes the layout of ECDH
737 * contexts and therefore is a compatibility break for applications that access
738 * fields of a mbedtls_ecdh_context structure directly. See also
739 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Dave Rodgman9eb2abd2023-11-08 11:36:00 +0000740 *
741 * The Everest code is provided under the Apache 2.0 license only; therefore enabling this
742 * option is not compatible with taking the library under the GPL v2.0-or-later license.
Gilles Peskinea8861e02023-09-05 20:20:51 +0200743 */
744//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
745
746/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100747 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200748 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100749 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
750 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200751 *
752 * Comment macros to disable the curve and functions for it
753 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200754/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
756#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
757#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
758#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
759#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
760#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
761#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
762#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
763#define MBEDTLS_ECP_DP_BP256R1_ENABLED
764#define MBEDTLS_ECP_DP_BP384R1_ENABLED
765#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200766/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200767#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000768#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200769
770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200772 *
773 * Enable specific 'modulo p' routines for each NIST prime.
774 * Depending on the prime and architecture, makes operations 4 to 8 times
775 * faster on the corresponding curve.
776 *
777 * Comment this macro to disable NIST curves optimisation.
778 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200780
781/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200782 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100783 *
784 * Enable "non-blocking" ECC operations that can return early and be resumed.
785 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200786 * This allows various functions to pause by returning
787 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
788 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
789 * order to further progress and eventually complete their operation. This is
790 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
791 * number of ECC operations a function may perform before pausing; see
792 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100793 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200794 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200795 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100796 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100797 * This option:
798 * - Adds xxx_restartable() variants of existing operations in the
799 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100800 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
801 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100802 * - ECDSA: signature generation & verification;
803 * - PK: signature generation & verification;
804 * - X509: certificate chain verification.
805 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
806 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
807 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
808 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000809 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100810 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100811 * - verification of the server's key exchange signature;
812 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100813 * - generation of the client's signature if client authentication is used,
814 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100815 *
816 * \note In the cases above, the usual SSL/TLS functions, such as
817 * mbedtls_ssl_handshake(), can now return
818 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200819 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100820 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
821 * restartable operations in PK, X.509 and TLS (see above) are not
822 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100823 * PSA, and are not restartable. These are temporary limitations that
824 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200825 *
Ron Eldor19779c42018-11-05 16:58:13 +0200826 * \note This option only works with the default software implementation of
827 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100828 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100829 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100830 * Requires: MBEDTLS_ECP_C
831 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100832 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100833 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200834//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100835
836/**
Gilles Peskinea8861e02023-09-05 20:20:51 +0200837 * Uncomment to enable using new bignum code in the ECC modules.
838 *
839 * \warning This is currently experimental, incomplete and therefore should not
840 * be used in production.
841 */
842//#define MBEDTLS_ECP_WITH_MPI_UINT
843
844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100846 *
847 * Enable deterministic ECDSA (RFC 6979).
848 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
849 * may result in a compromise of the long-term signing key. This is avoided by
850 * the deterministic variant.
851 *
John Durkop36a82e52020-10-26 09:39:05 -0700852 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100853 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100854 * Comment this macro to disable deterministic ECDSA.
855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200856#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100857
858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200860 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200861 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200862 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 * This enables the following ciphersuites (if other requisites are
864 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
866 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
867 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
868 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
869 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
870 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
871 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
872 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
873 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
874 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200877
878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200880 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200881 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200882 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 *
885 * This enables the following ciphersuites (if other requisites are
886 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
888 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
889 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
890 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
891 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
892 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
893 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
894 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
895 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
896 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100897 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100898 * \warning Using DHE constitutes a security risk as it
899 * is not possible to validate custom DH parameters.
900 * If possible, it is recommended users should consider
901 * preferring other methods of key exchange.
902 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100903 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200909 *
910 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
911 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200912 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
917 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
918 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
919 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
920 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
921 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200924
925/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200927 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200928 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200929 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
931 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200932 *
933 * This enables the following ciphersuites (if other requisites are
934 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
936 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
937 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
938 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
939 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
940 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
941 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
942 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
943 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
944 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200947
948/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200950 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200951 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200952 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
954 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200955 *
956 * This enables the following ciphersuites (if other requisites are
957 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
959 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
960 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
961 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
962 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
963 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
964 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
965 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
966 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
967 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
968 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
969 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200972
973/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200975 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200976 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
979 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200980 *
981 * This enables the following ciphersuites (if other requisites are
982 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
984 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
985 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
986 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
987 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
988 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
989 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
990 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
991 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
992 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
993 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
994 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100995 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100996 * \warning Using DHE constitutes a security risk as it
997 * is not possible to validate custom DH parameters.
998 * If possible, it is recommended users should consider
999 * preferring other methods of key exchange.
1000 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001001 *
Paul Bakkere07f41d2013-04-19 09:08:57 +02001002 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001004
1005/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001007 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001008 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +02001009 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001010 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1011 * MBEDTLS_RSA_C
1012 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +02001014 *
1015 * This enables the following ciphersuites (if other requisites are
1016 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1018 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1019 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1020 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1021 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1022 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1023 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1024 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1025 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1026 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +02001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +02001029
1030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001032 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001033 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001034 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001035 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1036 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1037 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001038 *
1039 * This enables the following ciphersuites (if other requisites are
1040 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1042 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1043 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1044 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1046 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1047 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1049 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1050 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +02001053
1054/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001056 *
1057 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
1058 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001059 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1060 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1061 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001062 *
1063 * This enables the following ciphersuites (if other requisites are
1064 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1066 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1067 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1068 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1072 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1073 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1074 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001077
1078/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001080 *
1081 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
1082 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001083 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
1084 * MBEDTLS_RSA_C
1085 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001086 *
1087 * This enables the following ciphersuites (if other requisites are
1088 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1090 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1091 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1092 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1093 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1094 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1095 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1096 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1097 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1098 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001101
1102/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001103 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1104 *
1105 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1106 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001107 * \warning This is currently experimental. EC J-PAKE support is based on the
1108 * Thread v1.0.0 specification; incompatible changes to the specification
1109 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001110 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001111 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001112 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001113 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1114 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001115 * \warning If SHA-256 is provided only by a PSA driver, you must call
1116 * psa_crypto_init() before the first hanshake (even if
1117 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1118 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001119 * This enables the following ciphersuites (if other requisites are
1120 * enabled as well):
1121 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1122 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001123//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001124
1125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001127 *
1128 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1129 * RFC 5915 and RFC 5480.
1130 *
1131 * Currently this means parsing the SpecifiedECDomain choice of EC
1132 * parameters (only known groups are supported, not arbitrary domains, to
1133 * avoid validation issues).
1134 *
1135 * Disable if you only need to support RFC 5915 + 5480 key formats.
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001138
1139/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001140 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1141 *
1142 * Enable the support for parsing public keys of type Short Weierstrass
1143 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001144 * compressed point format. This parsing is done through ECP module's functions.
1145 *
1146 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1147 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1148 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001149 */
1150#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1151
1152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001154 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * Enable a dummy error function to make use of mbedtls_strerror() in
1156 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1157 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1160 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001161 *
1162 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001166
1167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001169 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001170 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001175
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001178 *
1179 * Enable functions that use the filesystem.
1180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001182
1183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001185 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001186 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001187 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001188 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001189 * application.
1190 *
1191 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001194
1195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001196 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001197 *
1198 * Do not use built-in platform entropy functions.
1199 * This is useful if your platform does not support
1200 * standards like the /dev/urandom or Windows CryptoAPI.
1201 *
1202 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001203 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001205
1206/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001207 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001208 *
1209 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1210 * default SHA-512 based one (if both are available).
1211 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001212 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001213 *
1214 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1215 * if you have performance concerns.
1216 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001217 * This option is only useful if both MBEDTLS_SHA256_C and
1218 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001220//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001221
1222/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001223 * \def MBEDTLS_ENTROPY_NV_SEED
1224 *
1225 * Enable the non-volatile (NV) seed file-based entropy source.
1226 * (Also enables the NV seed read/write functions in the platform layer)
1227 *
1228 * This is crucial (if not required) on systems that do not have a
1229 * cryptographic entropy source (in hardware or kernel) available.
1230 *
1231 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1232 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001233 * \note The read/write functions that are used by the entropy source are
1234 * determined in the platform layer, and can be modified at runtime and/or
1235 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1236 *
1237 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001238 * with regular fopen(), please make sure you make a seedfile with the
1239 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1240 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001241 * and written to or you will get an entropy source error! The default
1242 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1243 * bytes from the file.
1244 *
1245 * \note The entropy collector will write to the seed file before entropy is
1246 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001247 */
1248//#define MBEDTLS_ENTROPY_NV_SEED
1249
Ronald Cron71016a92020-08-28 19:01:50 +02001250/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001251 *
Ronald Cron71016a92020-08-28 19:01:50 +02001252 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001253 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001254 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1255 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001256 *
1257 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001258 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001259 */
Ronald Cron71016a92020-08-28 19:01:50 +02001260//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001261
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001264 *
1265 * Enable debugging of buffer allocator memory issues. Automatically prints
1266 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1267 * function for 'debug output' of allocated memory.
1268 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001269 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001270 *
1271 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001274
1275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001277 *
1278 * Include backtrace information with each allocated block.
1279 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001280 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001281 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001282 *
1283 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001286
1287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001289 *
1290 * Support external private RSA keys (eg from a HSM) in the PK layer.
1291 *
1292 * Comment this macro to disable support for external private RSA keys.
1293 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001295
1296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001298 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001299 * Enable support for PKCS#1 v1.5 encoding.
1300 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001301 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001302 *
Paul Bakker48377d92013-08-30 12:06:24 +02001303 * This enables support for PKCS#1 v1.5 operations.
1304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001306
1307/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001309 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001310 * Enable support for PKCS#1 v2.1 encoding.
1311 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001312 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001313 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001314 * \warning If using a hash that is only provided by PSA drivers, you must
1315 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001316 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001317 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001320
Steven Cooreman6801f082021-02-19 17:21:22 +01001321/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1322 *
1323 * Enable support for platform built-in keys. If you enable this feature,
1324 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1325 * See the documentation of that function for more information.
1326 *
1327 * Built-in keys are typically derived from a hardware unique key or
1328 * stored in a secure element.
1329 *
1330 * Requires: MBEDTLS_PSA_CRYPTO_C.
1331 *
1332 * \warning This interface is experimental and may change or be removed
1333 * without notice.
1334 */
1335//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1336
Ronald Cron3768ac12021-01-26 16:58:00 +01001337/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1338 *
1339 * Enable support for PSA crypto client.
1340 *
1341 * \note This option allows to include the code necessary for a PSA
1342 * crypto client when the PSA crypto implementation is not included in
1343 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1344 * code to set and get PSA key attributes.
1345 * The development of PSA drivers partially relying on the library to
1346 * fulfill the hardware gaps is another possible usage of this option.
1347 *
1348 * \warning This interface is experimental and may change or be removed
1349 * without notice.
1350 */
1351//#define MBEDTLS_PSA_CRYPTO_CLIENT
1352
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001353/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1354 *
1355 * Make the PSA Crypto module use an external random generator provided
1356 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1357 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001358 * \note This random generator must deliver random numbers with cryptographic
1359 * quality and high performance. It must supply unpredictable numbers
1360 * with a uniform distribution. The implementation of this function
1361 * is responsible for ensuring that the random generator is seeded
1362 * with sufficient entropy. If you have a hardware TRNG which is slow
1363 * or delivers non-uniform output, declare it as an entropy source
1364 * with mbedtls_entropy_add_source() instead of enabling this option.
1365 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001366 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001367 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1368 * and define a function called mbedtls_psa_external_get_random()
1369 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001370 * ```
1371 * psa_status_t mbedtls_psa_external_get_random(
1372 * mbedtls_psa_external_random_context_t *context,
1373 * uint8_t *output, size_t output_size, size_t *output_length);
1374 * );
1375 * ```
1376 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001377 * The function must fill the \c output buffer with \c output_size bytes
1378 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001379 *
1380 * Requires: MBEDTLS_PSA_CRYPTO_C
1381 *
1382 * \warning If you enable this option, code that uses the PSA cryptography
1383 * interface will not use any of the entropy sources set up for
1384 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1385 * enables.
1386 *
1387 * \note This option is experimental and may be removed without notice.
1388 */
1389//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1390
Paul Bakker9dcc3222011-03-08 14:16:06 +00001391/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001392 * \def MBEDTLS_PSA_CRYPTO_SPM
1393 *
1394 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1395 * Partition Manager) integration which separates the code into two parts: a
1396 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1397 * Environment).
1398 *
Gilles Peskine7a6836b2023-09-27 15:48:47 +02001399 * If you enable this option, your build environment must include a header
1400 * file `"crypto_spe.h"` (either in the `psa` subdirectory of the Mbed TLS
1401 * header files, or in another directory on the compiler's include search
1402 * path). Alternatively, your platform may customize the header
1403 * `psa/crypto_platform.h`, in which case it can skip or replace the
1404 * inclusion of `"crypto_spe.h"`.
1405 *
Andrzej Kurekc6905232019-02-05 05:23:41 -05001406 * Module: library/psa_crypto.c
1407 * Requires: MBEDTLS_PSA_CRYPTO_C
1408 *
1409 */
1410//#define MBEDTLS_PSA_CRYPTO_SPM
1411
1412/**
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001413 * Uncomment to enable p256-m. This is an alternative implementation of
1414 * key generation, ECDH and (randomized) ECDSA on the curve SECP256R1.
1415 * Compared to the default implementation:
1416 *
1417 * - p256-m has a much smaller code size and RAM footprint.
1418 * - p256-m is only available via the PSA API. This includes the pk module
1419 * when #MBEDTLS_USE_PSA_CRYPTO is enabled.
1420 * - p256-m does not support deterministic ECDSA, EC-JPAKE, custom protocols
1421 * over the core arithmetic, or deterministic derivation of keys.
1422 *
1423 * We recommend enabling this option if your application uses the PSA API
1424 * and the only elliptic curve support it needs is ECDH and ECDSA over
1425 * SECP256R1.
1426 *
1427 * If you enable this option, you do not need to enable any ECC-related
1428 * MBEDTLS_xxx option. You do need to separately request support for the
1429 * cryptographic mechanisms through the PSA API:
1430 * - #MBEDTLS_PSA_CRYPTO_C and #MBEDTLS_PSA_CRYPTO_CONFIG for PSA-based
1431 * configuration;
1432 * - #MBEDTLS_USE_PSA_CRYPTO if you want to use p256-m from PK, X.509 or TLS;
1433 * - #PSA_WANT_ECC_SECP_R1_256;
1434 * - #PSA_WANT_ALG_ECDH and/or #PSA_WANT_ALG_ECDSA as needed;
1435 * - #PSA_WANT_KEY_TYPE_ECC_PUBLIC_KEY, #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_BASIC,
1436 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_IMPORT,
1437 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_EXPORT and/or
1438 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_GENERATE as needed.
Gilles Peskine67cf66b2023-09-20 23:19:46 +02001439 *
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001440 * \note To benefit from the smaller code size of p256-m, make sure that you
1441 * do not enable any ECC-related option not supported by p256-m: this
1442 * would cause the built-in ECC implementation to be built as well, in
1443 * order to provide the required option.
1444 * Make sure #PSA_WANT_ALG_DETERMINISTIC_ECDSA, #PSA_WANT_ALG_JPAKE and
Manuel Pégourié-Gonnarddfa42b32023-09-22 12:33:58 +02001445 * #PSA_WANT_KEY_TYPE_ECC_KEY_PAIR_DERIVE, and curves other than
1446 * SECP256R1 are disabled as they are not supported by this driver.
1447 * Also, avoid defining #MBEDTLS_PK_PARSE_EC_COMPRESSED or
1448 * #MBEDTLS_PK_PARSE_EC_EXTENDED as those currently require a subset of
Manuel Pégourié-Gonnard140c08e2023-09-28 11:02:37 +02001449 * the built-in ECC implementation, see docs/driver-only-builds.md.
Gilles Peskine08b66cd2023-09-20 20:51:47 +02001450 */
1451//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
1452
1453/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001454 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001455 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001456 * Enable support for entropy injection at first boot. This feature is
1457 * required on systems that do not have a built-in entropy source (TRNG).
1458 * This feature is currently not supported on systems that have a built-in
1459 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001460 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001461 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001462 *
1463 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001464//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001465
1466/**
David Horstmann4a48bec2024-03-13 15:42:31 +00001467 * \def MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001468 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001469 * Assume all buffers passed to PSA functions are owned exclusively by the
1470 * PSA function and are not stored in shared memory.
David Horstmann513101b2023-11-29 17:24:08 +00001471 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001472 * This option may be enabled if all buffers passed to any PSA function reside
1473 * in memory that is accessible only to the PSA function during its execution.
1474 *
1475 * This option MUST be disabled whenever buffer arguments are in memory shared
1476 * with an untrusted party, for example where arguments to PSA calls are passed
David Horstmann513101b2023-11-29 17:24:08 +00001477 * across a trust boundary.
1478 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001479 * \note Enabling this option reduces memory usage and code size.
David Horstmann0d405d82023-12-14 16:14:41 +00001480 *
David Horstmann4a48bec2024-03-13 15:42:31 +00001481 * \note Enabling this option causes overlap of input and output buffers
David Horstmannc09f36d2023-12-20 10:57:43 +00001482 * not to be supported by PSA functions.
David Horstmann513101b2023-11-29 17:24:08 +00001483 */
David Horstmann4a48bec2024-03-13 15:42:31 +00001484//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
David Horstmann513101b2023-11-29 17:24:08 +00001485
1486/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001488 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001489 * Do not use the Chinese Remainder Theorem
1490 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001491 *
1492 * Uncomment this macro to disable the use of CRT in RSA.
1493 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001496
1497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001499 *
1500 * Enable the checkup functions (*_self_test).
1501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001502#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001503
1504/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001505 * \def MBEDTLS_SHA256_SMALLER
1506 *
1507 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1508 * lower performance.
1509 *
Adam Wolf039080f2019-09-10 09:53:08 -05001510 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001511 * performance and size. This version optimizes more aggressively for size at
1512 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1513 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1514 * 30%.
1515 *
1516 * Uncomment to enable the smaller implementation of SHA256.
1517 */
1518//#define MBEDTLS_SHA256_SMALLER
1519
1520/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001521 * \def MBEDTLS_SHA512_SMALLER
1522 *
1523 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1524 * lower performance.
1525 *
1526 * Uncomment to enable the smaller implementation of SHA512.
1527 */
1528//#define MBEDTLS_SHA512_SMALLER
1529
1530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001532 *
1533 * Enable sending of alert messages in case of encountered errors as per RFC.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02001534 * If you choose not to send the alert messages, Mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001535 * with other servers, only debugging of failures is harder.
1536 *
1537 * The advantage of not sending alert messages, is that no information is given
1538 * about reasons for failures thus preventing adversaries of gaining intel.
1539 *
1540 * Enable sending of all alert messages
1541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001543
1544/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001545 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1546 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001547 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001548 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001549 * in the underlying transport. The CID functionality is described
1550 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001551 *
1552 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001553 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1554 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1555 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001556 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001557 * The maximum lengths of outgoing and incoming CIDs can be configured
1558 * through the options
1559 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1560 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1561 *
1562 * Requires: MBEDTLS_SSL_PROTO_DTLS
1563 *
1564 * Uncomment to enable the Connection ID extension.
1565 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001566#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1567
1568
1569/**
1570 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1571 *
1572 * Defines whether RFC 9146 (default) or the legacy version
1573 * (version draft-ietf-tls-dtls-connection-id-05,
1574 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1575 * is used.
1576 *
1577 * Set the value to 0 for the standard version, and
1578 * 1 for the legacy draft version.
1579 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001580 * \deprecated Support for the legacy version of the DTLS
1581 * Connection ID feature is deprecated. Please
1582 * switch to the standardized version defined
1583 * in RFC 9146 enabled by utilizing
1584 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1585 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1586 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001587 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1588 */
1589#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001590
1591/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001592 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1593 *
1594 * Enable asynchronous external private key operations in SSL. This allows
1595 * you to configure an SSL connection to call an external cryptographic
1596 * module to perform private key operations instead of performing the
1597 * operation inside the library.
1598 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001599 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001600 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001601//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001602
1603/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001604 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1605 *
1606 * Enable serialization of the TLS context structures, through use of the
1607 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1608 *
1609 * This pair of functions allows one side of a connection to serialize the
1610 * context associated with the connection, then free or re-use that context
1611 * while the serialized state is persisted elsewhere, and finally deserialize
1612 * that state to a live context for resuming read/write operations on the
1613 * connection. From a protocol perspective, the state of the connection is
1614 * unaffected, in particular this is entirely transparent to the peer.
1615 *
1616 * Note: this is distinct from TLS session resumption, which is part of the
1617 * protocol and fully visible by the peer. TLS session resumption enables
1618 * establishing new connections associated to a saved session with shorter,
1619 * lighter handshakes, while context serialization is a local optimization in
1620 * handling a single, potentially long-lived connection.
1621 *
1622 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1623 * saved after the handshake to allow for more efficient serialization, so if
1624 * you don't need this feature you'll save RAM by disabling it.
1625 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001626 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1627 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001628 * Comment to disable the context serialization APIs.
1629 */
1630#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1631
1632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001633 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001634 *
1635 * Enable the debug messages in SSL module for all issues.
1636 * Debug messages have been disabled in some places to prevent timing
1637 * attacks due to (unbalanced) debugging function calls.
1638 *
1639 * If you need all error reporting you should enable this during debugging,
1640 * but remove this for production servers that should log as well.
1641 *
1642 * Uncomment this macro to report all debug messages on errors introducing
1643 * a timing side-channel.
1644 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001647
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001648/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001649 *
1650 * Enable support for Encrypt-then-MAC, RFC 7366.
1651 *
1652 * This allows peers that both support it to use a more robust protection for
1653 * ciphersuites using CBC, providing deep resistance against timing attacks
1654 * on the padding or underlying cipher.
1655 *
1656 * This only affects CBC ciphersuites, and is useless if none is defined.
1657 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001658 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001659 *
1660 * Comment this macro to disable support for Encrypt-then-MAC
1661 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001663
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001664/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001665 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001666 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1667 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001668 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001669 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001670 * attacks, but it is recommended to always use it (even if you disable
1671 * renegotiation), since it actually fixes a more fundamental issue in the
1672 * original SSL/TLS design, and has implications beyond Triple Handshake.
1673 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001674 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001675 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001676 * Comment this macro to disable support for Extended Master Secret.
1677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001679
Paul Bakkerd66f0702013-01-31 16:57:45 +01001680/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001681 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1682 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001683 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001684 * giving access to the peer's certificate after completion of the handshake.
1685 *
1686 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1687 * recommended to disable this option for reduced RAM usage.
1688 *
1689 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1690 * defined, but always returns \c NULL.
1691 *
1692 * \note This option has no influence on the protection against the
1693 * triple handshake attack. Even if it is disabled, Mbed TLS will
1694 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001695 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001696 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001697 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001698 *
1699 * Comment this macro to disable storing the peer's certificate
1700 * after the handshake.
1701 */
1702#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1703
1704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001706 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001707 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001708 *
1709 * The two main uses of renegotiation are (1) refresh keys on long-lived
1710 * connections and (2) client authentication after the initial handshake.
1711 * If you don't need renegotiation, it's probably better to disable it, since
1712 * it has been associated with security issues in the past and is easy to
1713 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001714 *
jnmeurisse83f0a652023-09-16 18:12:18 +02001715 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
1716 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001717 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001718 *
1719 * \note Even if this option is disabled, both client and server are aware
1720 * of the Renegotiation Indication Extension (RFC 5746) used to
1721 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1722 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1723 * configuration of this extension).
1724 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001727
1728/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001730 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001731 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001732 *
1733 * Comment this macro to disable support for the max_fragment_length extension
1734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001736
1737/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001738 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1739 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001740 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001741 *
Jan Bruckner151f6422023-02-10 12:45:19 +01001742 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1743 *
1744 * Uncomment this macro to enable support for the record_size_limit extension
1745 */
1746//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1747
1748/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001749 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001750 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001751 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001752 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001753 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001754 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1755 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001756 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001757 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001758 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001759 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1760 * are only provided by PSA drivers, you must call psa_crypto_init() before
1761 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001762 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001763 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001766
1767/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001768 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001769 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001770 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001771 *
Gilles Peskineda69eaa2023-09-05 20:54:17 +02001772 * \note See docs/architecture/tls13-support.md for a description of the TLS
Ronald Cron6f135e12021-12-08 16:57:54 +01001773 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001774 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001775 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001776 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001777 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001778 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1779 * directly performed by TLS 1.3 code. As a consequence, you must
1780 * call psa_crypto_init() before the first TLS 1.3 handshake.
1781 *
1782 * \note Cryptographic operations performed indirectly via another module
1783 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1784 * running handshake hash) only use PSA crypto if
1785 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001786 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001787 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001788 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001789#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001790
1791/**
Ronald Cronab65c522021-11-24 10:47:20 +01001792 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1793 *
1794 * Enable TLS 1.3 middlebox compatibility mode.
1795 *
1796 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1797 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1798 * expecting TLS 1.2 traffic.
1799 *
1800 * Turning on the compatibility mode comes at the cost of a few added bytes
1801 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1802 * that don't use it. Therefore, unless transmission bandwidth is critical and
1803 * you know that middlebox compatibility issues won't occur, it is therefore
1804 * recommended to set this option.
1805 *
1806 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001807 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1808 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001809 *
1810 */
Ronald Cron27eb68d2024-03-15 16:13:37 +01001811#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
Ronald Cronab65c522021-11-24 10:47:20 +01001812
1813/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001814 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1815 *
1816 * Enable TLS 1.3 PSK key exchange mode.
1817 *
1818 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1819 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1820 * effect on the build.
1821 *
1822 */
1823#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1824
1825/**
1826 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1827 *
1828 * Enable TLS 1.3 ephemeral key exchange mode.
1829 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001830 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001831 * MBEDTLS_X509_CRT_PARSE_C
1832 * and at least one of:
1833 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1834 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001835 *
1836 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1837 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1838 * effect on the build.
1839 *
1840 */
1841#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1842
1843/**
1844 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1845 *
1846 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1847 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001848 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001849 *
1850 * Comment to disable support for the PSK ephemeral key exchange mode in
1851 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1852 * have any effect on the build.
1853 *
1854 */
1855#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1856
1857/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 * \def MBEDTLS_SSL_EARLY_DATA
1859 *
1860 * Enable support for RFC 8446 TLS 1.3 early data.
1861 *
1862 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1863 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1864 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1865 *
1866 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1867 * is not enabled, this option does not have any effect on the build.
1868 *
Tom Cosgrovea63775b2023-09-14 13:31:19 +01001869 * \note The maximum amount of early data can be set with
1870 * MBEDTLS_SSL_MAX_EARLY_DATA_SIZE.
1871 *
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001873//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001874
1875/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001876 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001877 *
1878 * Enable support for DTLS (all available versions).
1879 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001880 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001881 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001882 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001883 *
1884 * Comment this macro to disable support for DTLS
1885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001887
1888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001890 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001891 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001892 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001893 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001896
1897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001899 *
1900 * Enable support for the anti-replay mechanism in DTLS.
1901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * Requires: MBEDTLS_SSL_TLS_C
1903 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001904 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001905 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001906 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001907 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001908 * Comment this to disable anti-replay in DTLS.
1909 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001911
1912/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001914 *
1915 * Enable support for HelloVerifyRequest on DTLS servers.
1916 *
1917 * This feature is highly recommended to prevent DTLS servers being used as
1918 * amplifiers in DoS attacks against other hosts. It should always be enabled
1919 * unless you know for sure amplification cannot be a problem in the
1920 * environment in which your server operates.
1921 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001922 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001923 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001924 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001925 *
1926 * Comment this to disable support for HelloVerifyRequest.
1927 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001929
1930/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001931 * \def MBEDTLS_SSL_DTLS_SRTP
1932 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001933 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001934 * through the use_srtp extension.
1935 *
1936 * \note This feature provides the minimum functionality required
1937 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1938 * the associated SRTP packet protection key material.
1939 * In particular, the SRTP packet protection itself, as well as the
1940 * demultiplexing of RTP and DTLS packets at the datagram layer
1941 * (see Section 5 of RFC 5764), are not handled by this feature.
1942 * Instead, after successful completion of a handshake negotiating
1943 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001944 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001945 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1946 * (this is implemented in the SSL example programs).
1947 * The resulting key should then be passed to an SRTP stack.
1948 *
1949 * Setting this option enables the runtime API
1950 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1951 * through which the supported DTLS-SRTP protection
1952 * profiles can be configured. You must call this API at
1953 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001954 *
1955 * Requires: MBEDTLS_SSL_PROTO_DTLS
1956 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001957 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001958 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001959//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001960
1961/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001962 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1963 *
1964 * Enable server-side support for clients that reconnect from the same port.
1965 *
1966 * Some clients unexpectedly close the connection and try to reconnect using the
1967 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001968 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001969 * flag enables that support.
1970 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001971 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001972 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001973 * Comment this to disable support for clients reusing the source port.
1974 */
1975#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1976
1977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001979 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001980 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001981 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001982 * session store remains the responsibility of the application, though).
1983 * Server-side, you also need to provide callbacks for writing and parsing
1984 * tickets, including authenticated encryption and key management. Example
1985 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001986 *
1987 * Comment this macro to disable support for SSL session tickets
1988 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001990
1991/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001993 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001994 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001997 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001998 * Comment this macro to disable support for server name indication in SSL
1999 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02002001
2002/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01002003 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2004 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05002005 * When this option is enabled, the SSL buffer will be resized automatically
2006 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02002007 *
2008 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01002009 */
2010//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
2011
2012/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002013 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2014 *
2015 * Enable testing of the constant-flow nature of some sensitive functions with
2016 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002017 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002018 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002019 * This setting requires compiling with clang -fsanitize=memory. The test
2020 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002021 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02002022 * \warning This macro is only used for extended testing; it is not considered
2023 * part of the library's API, so it may change or disappear at any time.
2024 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02002025 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02002026 */
2027//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
2028
2029/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002030 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2031 *
2032 * Enable testing of the constant-flow nature of some sensitive functions with
2033 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002034 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002035 *
2036 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02002037 * testing if the tests suites are run with valgrind's memcheck. This can be
2038 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
2039 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02002040 *
2041 * \warning This macro is only used for extended testing; it is not considered
2042 * part of the library's API, so it may change or disappear at any time.
2043 *
2044 * Uncomment to enable testing of the constant-flow nature of selected code.
2045 */
2046//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
2047
2048/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02002049 * \def MBEDTLS_TEST_HOOKS
2050 *
2051 * Enable features for invasive testing such as introspection functions and
2052 * hooks for fault injection. This enables additional unit tests.
2053 *
2054 * Merely enabling this feature should not change the behavior of the product.
2055 * It only adds new code, and new branching points where the default behavior
2056 * is the same as when this feature is disabled.
2057 * However, this feature increases the attack surface: there is an added
2058 * risk of vulnerabilities, and more gadgets that can make exploits easier.
2059 * Therefore this feature must never be enabled in production.
2060 *
2061 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
2062 * information.
2063 *
2064 * Uncomment to enable invasive tests.
2065 */
2066//#define MBEDTLS_TEST_HOOKS
2067
2068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002070 *
2071 * Provide your own alternate threading implementation.
2072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002074 *
2075 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02002076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002077//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02002078
2079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002081 *
2082 * Enable the pthread wrapper layer for the threading layer.
2083 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002085 *
2086 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02002087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02002089
2090/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002091 * \def MBEDTLS_USE_PSA_CRYPTO
2092 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002093 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
2094 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002095 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01002096 * \note Development of this option is currently in progress, and parts of Mbed
2097 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04002098 * will still continue to work as usual, so enabling this option should not
2099 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002100 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02002101 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02002102 * before calling any function from the SSL/TLS, X.509 or PK modules, except
2103 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00002104 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002105 * \note An important and desirable effect of this option is that it allows
2106 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
2107 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02002108 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02002109 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
2110 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01002111 *
2112 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02002113 *
2114 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01002115 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04002116 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002117 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02002118//#define MBEDTLS_USE_PSA_CRYPTO
2119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120/**
John Durkop6e33dbe2020-09-17 21:15:13 -07002121 * \def MBEDTLS_PSA_CRYPTO_CONFIG
2122 *
John Durkop185764f2020-10-12 21:32:12 -07002123 * This setting allows support for cryptographic mechanisms through the PSA
2124 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07002125 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02002126 * When this option is disabled, the PSA API exposes the cryptographic
2127 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
2128 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01002129 *
2130 * When this option is enabled, the PSA API exposes the cryptographic
2131 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2132 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2133 * automatically enabled if required (i.e. if no PSA driver provides the
2134 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2135 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002136 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002137 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002138 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002139 *
Gilles Peskine25b4e722023-07-27 15:05:12 +02002140 * \warning This option is experimental, in that the set of `PSA_WANT_XXX`
2141 * symbols is not completely finalized yet, and the configuration
2142 * tooling is not ideally adapted to having two separate configuration
2143 * files.
2144 * Future minor releases of Mbed TLS may make minor changes to those
2145 * symbols, but we will endeavor to provide a transition path.
2146 * Nonetheless, this option is considered mature enough to use in
2147 * production, as long as you accept that you may need to make
2148 * minor changes to psa/crypto_config.h when upgrading Mbed TLS.
John Durkop6e33dbe2020-09-17 21:15:13 -07002149 */
2150//#define MBEDTLS_PSA_CRYPTO_CONFIG
2151
2152/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002153 * \def MBEDTLS_VERSION_FEATURES
2154 *
2155 * Allow run-time checking of compile-time enabled features. Thus allowing users
2156 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002157 * support via mbedtls_version_check_feature().
2158 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002159 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002160 *
2161 * Comment this to disable run-time checking and save ROM space
2162 */
2163#define MBEDTLS_VERSION_FEATURES
2164
2165/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002166 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2167 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002168 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002169 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2170 * the set of trusted certificates through a callback instead of a linked
2171 * list.
2172 *
2173 * This is useful for example in environments where a large number of trusted
2174 * certificates is present and storing them in a linked list isn't efficient
2175 * enough, or when the set of trusted certificates changes frequently.
2176 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002177 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002178 * `mbedtls_ssl_conf_ca_cb()` for more information.
2179 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002180 * Requires: MBEDTLS_X509_CRT_PARSE_C
2181 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002182 * Uncomment to enable trusted certificate callbacks.
2183 */
2184//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2185
2186/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002187 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002188 *
Chris Jones2c745862020-12-16 11:41:06 +00002189 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002190 *
Chris Jones2c745862020-12-16 11:41:06 +00002191 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002192 * and other functions/constants only used by these functions, thus reducing
2193 * the code footprint by several KB.
2194 */
Chris Jones2c745862020-12-16 11:41:06 +00002195//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002196
2197/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002199 *
2200 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2201 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2202 *
Tomi Fontanillesa70b3c22023-07-16 12:06:13 +03002203 * Requires: MBEDTLS_PKCS1_V21
2204 *
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002205 * Comment this macro to disallow using RSASSA-PSS in certificates.
2206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002208/** \} name SECTION: Mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002209
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002210/**
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002211 * \name SECTION: Mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002212 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002213 * This section enables or disables entire modules in Mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002214 * \{
2215 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002216
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002217/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002218 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002219 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002220 * Enable AES-NI support on x86-64 or x86-32.
2221 *
2222 * \note AESNI is only supported with certain compilers and target options:
Bence Szépkútie05b5422024-03-15 12:18:04 +01002223 * - Visual Studio: supported
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002224 * - GCC, x86-64, target not explicitly supporting AESNI:
2225 * requires MBEDTLS_HAVE_ASM.
2226 * - GCC, x86-32, target not explicitly supporting AESNI:
2227 * not supported.
2228 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2229 * For this assembly-less implementation, you must currently compile
2230 * `library/aesni.c` and `library/aes.c` with machine options to enable
2231 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2232 * `clang -maes -mpclmul`.
2233 * - Non-x86 targets: this option is silently ignored.
2234 * - Other compilers: this option is silently ignored.
2235 *
2236 * \note
2237 * Above, "GCC" includes compatible compilers such as Clang.
2238 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002239 *
2240 * Module: library/aesni.c
2241 * Caller: library/aes.c
2242 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002243 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002244 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002245 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002248
2249/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002250 * \def MBEDTLS_AESCE_C
2251 *
Dave Rodgman18838f62023-10-08 12:28:51 +01002252 * Enable AES cryptographic extension support on Armv8.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002253 *
2254 * Module: library/aesce.c
2255 * Caller: library/aes.c
2256 *
Jerry Yuf015a932023-04-25 10:38:03 +08002257 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002258 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002259 * \warning Runtime detection only works on Linux. For non-Linux operating
2260 * system, Armv8-A Cryptographic Extensions must be supported by
2261 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002262 *
Dave Rodgman48b965d2023-10-09 12:19:44 +01002263 * \note Minimum compiler versions for this feature when targeting aarch64
2264 * are Clang 4.0; armclang 6.6; GCC 6.0; or MSVC 2019 version 16.11.2.
2265 * Minimum compiler versions for this feature when targeting 32-bit
2266 * Arm or Thumb are Clang 11.0; armclang 6.20; or GCC 6.0.
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002267 *
2268 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2269 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002270 *
Dave Rodgman4b8e8dc2023-10-08 21:41:40 +01002271 * This module adds support for the AES Armv8-A Cryptographic Extensions on Armv8 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002272 */
2273#define MBEDTLS_AESCE_C
2274
2275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002277 *
2278 * Enable the AES block cipher.
2279 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002280 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002281 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002282 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002283 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002284 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002285 * This module enables the following ciphersuites (if other requisites are
2286 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002287 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2288 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2289 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2290 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2291 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2292 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2293 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2294 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2295 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2296 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2297 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2298 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2299 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2300 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2301 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2302 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2303 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2304 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2305 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2306 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2307 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2308 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2309 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2310 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2311 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2312 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2313 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2314 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2315 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2316 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2317 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2318 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2319 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2320 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2321 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2322 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2323 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2324 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2325 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2326 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2327 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2328 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2329 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2330 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2331 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2332 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2333 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2334 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2335 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2336 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2337 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2338 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2339 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2340 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2341 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2342 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2343 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2344 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002345 *
Paul Bakkercff68422013-09-15 20:43:33 +02002346 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002347 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002349
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002350/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002352 *
2353 * Enable the generic ASN1 parser.
2354 *
2355 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002356 * Caller: library/x509.c
2357 * library/dhm.c
2358 * library/pkcs12.c
2359 * library/pkcs5.c
2360 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002363
2364/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002366 *
2367 * Enable the generic ASN1 writer.
2368 *
2369 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002370 * Caller: library/ecdsa.c
2371 * library/pkwrite.c
2372 * library/x509_create.c
2373 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002374 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002377
2378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002379 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002380 *
2381 * Enable the Base64 module.
2382 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002383 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002384 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002385 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002386 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002389
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002390/**
Yanray Wange367e472023-10-31 17:23:04 +08002391 * \def MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2392 *
2393 * Remove decryption operation for AES, ARIA and Camellia block cipher.
2394 *
2395 * \note This feature is incompatible with insecure block cipher,
2396 * MBEDTLS_DES_C, and cipher modes which always require decryption
2397 * operation, MBEDTLS_CIPHER_MODE_CBC, MBEDTLS_CIPHER_MODE_XTS and
Yanray Wang16b00f92023-11-27 15:52:24 +08002398 * MBEDTLS_NIST_KW_C. When #MBEDTLS_PSA_CRYPTO_CONFIG is enabled,
2399 * this feature is incompatible with following supported PSA equivalence,
2400 * PSA_WANT_ALG_ECB_NO_PADDING, PSA_WANT_ALG_CBC_NO_PADDING,
2401 * PSA_WANT_ALG_CBC_PKCS7 and PSA_WANT_KEY_TYPE_DES.
Yanray Wange367e472023-10-31 17:23:04 +08002402 *
2403 * Module: library/aes.c
2404 * library/aesce.c
2405 * library/aesni.c
2406 * library/aria.c
2407 * library/camellia.c
2408 * library/cipher.c
2409 */
2410//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
2411
2412/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002414 *
Paul Bakker9a736322012-11-14 12:39:52 +00002415 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002416 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002417 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002418 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002419 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002420 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002421 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002422 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002423 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002425 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002426 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002428 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002431
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002434 *
2435 * Enable the Camellia block cipher.
2436 *
Paul Bakker38119b12009-01-10 23:31:23 +00002437 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002438 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002439 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002440 * This module enables the following ciphersuites (if other requisites are
2441 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2443 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2444 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2445 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2446 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2447 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2448 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2449 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2450 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2451 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2452 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2453 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2454 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2455 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2456 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2457 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2458 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2459 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2460 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2461 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2462 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2463 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2464 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2465 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2466 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2467 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2468 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2469 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2470 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2471 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2472 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2473 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2474 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2475 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2476 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2477 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2478 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2479 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2480 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2481 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2482 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2483 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002486
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002487/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002488 * \def MBEDTLS_ARIA_C
2489 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002490 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002491 *
2492 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002493 * Caller: library/cipher.c
2494 *
2495 * This module enables the following ciphersuites (if other requisites are
2496 * enabled as well):
2497 *
2498 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2499 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2500 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2501 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2502 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2503 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2504 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2505 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2506 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2507 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2508 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2509 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2510 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2511 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2512 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2513 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2514 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2515 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2516 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2517 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2518 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2519 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2520 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2521 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2522 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2523 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2524 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2525 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2526 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2527 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2528 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2529 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2530 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2531 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2532 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2533 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2534 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2535 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002536 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002537#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002541 *
2542 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2543 *
2544 * Module: library/ccm.c
2545 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002546 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2547 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002548 *
2549 * This module enables the AES-CCM ciphersuites, if other requisites are
2550 * enabled as well.
2551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002553
2554/**
Daniel King34b822c2016-05-15 17:28:08 -03002555 * \def MBEDTLS_CHACHA20_C
2556 *
2557 * Enable the ChaCha20 stream cipher.
2558 *
2559 * Module: library/chacha20.c
2560 */
2561#define MBEDTLS_CHACHA20_C
2562
2563/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002564 * \def MBEDTLS_CHACHAPOLY_C
2565 *
2566 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2567 *
2568 * Module: library/chachapoly.c
2569 *
2570 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2571 */
2572#define MBEDTLS_CHACHAPOLY_C
2573
2574/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002576 *
2577 * Enable the generic cipher layer.
2578 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002579 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002580 * Caller: library/ccm.c
2581 * library/cmac.c
2582 * library/gcm.c
2583 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002584 * library/pkcs12.c
2585 * library/pkcs5.c
2586 * library/psa_crypto_aead.c
2587 * library/psa_crypto_mac.c
2588 * library/ssl_ciphersuites.c
2589 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002590 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Valerio Settid5cab812023-12-28 10:04:51 +01002591 * Auto-enabled by: MBEDTLS_PSA_CRYPTO_C depending on which ciphers are enabled
2592 * (see the documentation of that option for details).
Paul Bakker8123e9d2011-01-06 15:37:30 +00002593 *
2594 * Uncomment to enable generic cipher wrappers.
2595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002597
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002598/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002599 * \def MBEDTLS_CMAC_C
2600 *
Simon Butcher327398a2016-10-05 14:09:11 +01002601 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2602 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002603 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002604 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2605 * implementation of the CMAC algorithm is provided by an alternate
2606 * implementation, that alternate implementation may opt to not support
2607 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2608 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002609 * Module: library/cmac.c
2610 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002611 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002612 *
2613 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002614#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002615
2616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002618 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002619 * Enable the CTR_DRBG AES-based random generator.
2620 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002621 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002622 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002623 * AES support can either be achived through builtin (MBEDTLS_AES_C) or PSA.
2624 * Builtin is the default option when MBEDTLS_AES_C is defined otherwise PSA
2625 * is used.
2626 *
2627 * \warning When using PSA, the user should call `psa_crypto_init()` before
2628 * using any CTR_DRBG operation (except `mbedtls_ctr_drbg_init()`).
2629 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002630 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2631 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002632 * \note To achieve a 256-bit security strength with CTR_DRBG,
2633 * you must use AES-256 *and* use sufficient entropy.
2634 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002635 *
2636 * Module: library/ctr_drbg.c
2637 * Caller:
2638 *
Valerio Setti7ab90722023-11-23 16:29:51 +01002639 * Requires: MBEDTLS_AES_C or
2640 * (PSA_WANT_KEY_TYPE_AES and PSA_WANT_ALG_ECB_NO_PADDING and
2641 * MBEDTLS_PSA_CRYPTO_C)
Paul Bakker6083fd22011-12-03 21:45:14 +00002642 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002643 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002644 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002646
2647/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002649 *
2650 * Enable the debug functions.
2651 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002652 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002653 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002654 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002655 * library/ssl_tls12_*.c
2656 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002657 *
2658 * This module provides debugging functions.
2659 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002661
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002664 *
2665 * Enable the DES block cipher.
2666 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002667 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002668 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002669 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 *
Paul Bakkercff68422013-09-15 20:43:33 +02002671 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002672 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002673 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002674 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002677
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002680 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002681 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002682 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002683 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002684 * Caller: library/ssl_tls.c
2685 * library/ssl*_client.c
2686 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002687 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002688 * This module is used by the following key exchanges:
2689 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002690 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002691 * \warning Using DHE constitutes a security risk as it
2692 * is not possible to validate custom DH parameters.
2693 * If possible, it is recommended users should consider
2694 * preferring other methods of key exchange.
2695 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002696 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002699
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002702 *
2703 * Enable the elliptic curve Diffie-Hellman library.
2704 *
2705 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002706 * Caller: library/psa_crypto.c
2707 * library/ssl_tls.c
2708 * library/ssl*_client.c
2709 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002710 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002711 * This module is used by the following key exchanges:
2712 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002713 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002717
2718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002720 *
2721 * Enable the elliptic curve DSA library.
2722 *
2723 * Module: library/ecdsa.c
2724 * Caller:
2725 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002726 * This module is used by the following key exchanges:
2727 * ECDHE-ECDSA
2728 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002729 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2730 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2731 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002734
2735/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002736 * \def MBEDTLS_ECJPAKE_C
2737 *
2738 * Enable the elliptic curve J-PAKE library.
2739 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002740 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2741 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002742 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002743 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002744 * Module: library/ecjpake.c
2745 * Caller:
2746 *
2747 * This module is used by the following key exchanges:
2748 * ECJPAKE
2749 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002750 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002751 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002752 * \warning If using a hash that is only provided by PSA drivers, you must
2753 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002754 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002755#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002756
2757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002759 *
2760 * Enable the elliptic curve over GF(p) library.
2761 *
2762 * Module: library/ecp.c
2763 * Caller: library/ecdh.c
2764 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002765 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002766 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002767 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002770
2771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002773 *
2774 * Enable the platform-specific entropy code.
2775 *
2776 * Module: library/entropy.c
2777 * Caller:
2778 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002780 *
2781 * This module provides a generic entropy pool
2782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002784
2785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002787 *
2788 * Enable error code to error string conversion.
2789 *
2790 * Module: library/error.c
2791 * Caller:
2792 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002796
2797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002799 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002800 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002801 *
2802 * Module: library/gcm.c
2803 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002804 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2805 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002806 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002807 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2808 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002811
2812/**
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002813 * \def MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002814 *
Matthias Schulzf3116342024-02-08 18:35:36 +01002815 * Enable large pre-computed tables for Galois/Counter Mode (GCM).
Matthias Schulz0767fda2024-02-07 10:46:28 +01002816 * Can significantly increase throughput on systems without GCM hardware
2817 * acceleration (e.g., AESNI, AESCE).
2818 *
Matthias Schulz78266782024-02-08 13:54:48 +01002819 * The mbedtls_gcm_context size will increase by 3840 bytes.
2820 * The code size will increase by roughly 344 bytes.
2821 *
Matthias Schulz0767fda2024-02-07 10:46:28 +01002822 * Module: library/gcm.c
2823 *
2824 * Requires: MBEDTLS_GCM_C
Matthias Schulz0767fda2024-02-07 10:46:28 +01002825 */
Matthias Schulza6ac0f12024-02-09 17:09:42 +01002826//#define MBEDTLS_GCM_LARGE_TABLE
Matthias Schulz0767fda2024-02-07 10:46:28 +01002827
2828/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002829 * \def MBEDTLS_HKDF_C
2830 *
2831 * Enable the HKDF algorithm (RFC 5869).
2832 *
2833 * Module: library/hkdf.c
2834 * Caller:
2835 *
2836 * Requires: MBEDTLS_MD_C
2837 *
2838 * This module adds support for the Hashed Message Authentication Code
2839 * (HMAC)-based key derivation function (HKDF).
2840 */
2841#define MBEDTLS_HKDF_C
2842
2843/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002845 *
2846 * Enable the HMAC_DRBG random generator.
2847 *
2848 * Module: library/hmac_drbg.c
2849 * Caller:
2850 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002852 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002853 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002856
2857/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002858 * \def MBEDTLS_LMS_C
2859 *
2860 * Enable the LMS stateful-hash asymmetric signature algorithm.
2861 *
2862 * Module: library/lms.c
2863 * Caller:
2864 *
Raef Colesab4f8742022-09-01 12:24:31 +01002865 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002866 *
Raef Colesab4f8742022-09-01 12:24:31 +01002867 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002868 */
2869#define MBEDTLS_LMS_C
2870
2871/**
Raef Colesab4f8742022-09-01 12:24:31 +01002872 * \def MBEDTLS_LMS_PRIVATE
2873 *
2874 * Enable LMS private-key operations and signing code. Functions enabled by this
2875 * option are experimental, and should not be used in production.
2876 *
2877 * Requires: MBEDTLS_LMS_C
2878 *
2879 * Uncomment to enable the LMS signature algorithm and private key operations.
2880 */
Raef Coles5127e852022-10-07 10:35:56 +01002881//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002882
2883/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002884 * \def MBEDTLS_NIST_KW_C
2885 *
2886 * Enable the Key Wrapping mode for 128-bit block ciphers,
2887 * as defined in NIST SP 800-38F. Only KW and KWP modes
2888 * are supported. At the moment, only AES is approved by NIST.
2889 *
2890 * Module: library/nist_kw.c
2891 *
2892 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2893 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002894#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002895
2896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002898 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002899 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002900 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002901 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2902 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002903 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002904 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002905 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002906 * Caller: library/constant_time.c
2907 * library/ecdsa.c
2908 * library/ecjpake.c
2909 * library/hkdf.c
2910 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002911 * library/pk.c
2912 * library/pkcs5.c
2913 * library/pkcs12.c
2914 * library/psa_crypto_ecp.c
2915 * library/psa_crypto_rsa.c
2916 * library/rsa.c
2917 * library/ssl_cookie.c
2918 * library/ssl_msg.c
2919 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002920 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002921 * library/x509_crt.c
2922 * library/x509write_crt.c
2923 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002924 *
2925 * Uncomment to enable generic message digest wrappers.
2926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002928
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002930 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002931 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002932 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002933 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002934 * Module: library/md5.c
2935 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002936 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002937 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002938 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002939 * This module is required for TLS 1.2 depending on the handshake parameters.
2940 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2941 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002942 *
2943 * \warning MD5 is considered a weak message digest and its use constitutes a
2944 * security risk. If possible, we recommend avoiding dependencies on
2945 * it, and considering stronger message digests instead.
2946 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002949
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002952 *
2953 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002954 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002955 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002956 *
2957 * Module: library/memory_buffer_alloc.c
2958 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959 * Requires: MBEDTLS_PLATFORM_C
Gilles Peskinee820c0a2023-08-03 17:45:20 +02002960 * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002961 *
2962 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002965
2966/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002968 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002969 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2970 *
Simon Butcherd567a232016-03-09 20:19:21 +00002971 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2972 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002973 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002974 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002975 * \note See also our Knowledge Base article about porting to a new
2976 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002977 * 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 +00002978 *
Andres AG788aa4a2016-09-14 14:32:09 +01002979 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002980 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002981 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002984
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002985/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002987 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002988 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002989 *
2990 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002991 * Caller: library/asn1write.c
2992 * library/pkcs5.c
2993 * library/pkparse.c
2994 * library/pkwrite.c
2995 * library/rsa.c
2996 * library/x509.c
2997 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002998 * library/x509_crl.c
2999 * library/x509_crt.c
3000 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003001 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003002 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02003003 *
3004 * This modules translates between OIDs and internal values.
3005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02003007
3008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003010 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003011 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00003012 *
3013 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003014 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02003015 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003016 * library/x509_crl.c
3017 * library/x509_crt.c
3018 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00003019 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01003021 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
3022 *
3023 * \warning When parsing password-protected files, if MD5 is provided only by
3024 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00003025 *
Paul Bakkercff68422013-09-15 20:43:33 +02003026 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00003027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003029
3030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02003032 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003033 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02003034 *
3035 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003036 * Caller: library/pkwrite.c
3037 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003038 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02003039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02003041 *
3042 * This modules adds support for encoding / writing PEM files.
3043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00003045
3046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003048 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003049 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003050 *
3051 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003052 * Caller: library/psa_crypto_rsa.c
3053 * library/ssl_tls.c
3054 * library/ssl*_client.c
3055 * library/ssl*_server.c
3056 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003057 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02003058 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02003059 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003060 * Uncomment to enable generic public key wrappers.
3061 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02003063
3064/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003066 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003067 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02003068 *
3069 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003070 * Caller: library/x509_crt.c
3071 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02003072 *
Yanray Wang072a0682023-12-05 10:53:04 +08003073 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003074 *
3075 * Uncomment to enable generic public key parse functions.
3076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003078
3079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003080 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003081 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003082 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02003083 *
3084 * Module: library/pkwrite.c
3085 * Caller: library/x509write.c
3086 *
Yanray Wanga8f8eb12023-12-05 11:00:33 +08003087 * Requires: MBEDTLS_ASN1_WRITE_C, MBEDTLS_OID_C, MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02003088 *
3089 * Uncomment to enable generic public key write functions.
3090 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02003092
3093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003095 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003096 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003097 *
3098 * Module: library/pkcs5.c
3099 *
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01003100 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003101 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01003102 * \warning If using a hash that is only provided by PSA drivers, you must
3103 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003104 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003105 * This module adds support for the PKCS#5 functions.
3106 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02003108
3109/**
Nayna Jainc9deb182020-11-16 19:03:12 +00003110 * \def MBEDTLS_PKCS7_C
3111 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00003112 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00003113 * RFC Link - https://tools.ietf.org/html/rfc2315
3114 *
3115 * Module: library/pkcs7.c
3116 *
3117 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06003118 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
3119 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003120 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00003121 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00003122 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00003123#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00003124
3125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003127 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003128 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003129 * Adds algorithms for parsing PKCS#8 encrypted private keys
3130 *
3131 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003132 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003133 *
Valerio Settie98ad592023-12-28 10:42:12 +01003134 * Requires: MBEDTLS_ASN1_PARSE_C and either MBEDTLS_MD_C or
3135 * MBEDTLS_PSA_CRYPTO_C.
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04003136 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01003137 * \warning If using a hash that is only provided by PSA drivers, you must
3138 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01003139 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003140 * This module enables PKCS#12 functions.
3141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02003143
3144/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003145 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003146 *
3147 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003148 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01003149 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
3151 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00003152 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01003153 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003154 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02003155 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02003156 *
Paul Bakker747a83a2014-02-01 22:50:07 +01003157 * Module: library/platform.c
3158 * Caller: Most other .c files
3159 *
3160 * This module enables abstraction of common (libc) functions.
3161 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003162#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01003163
3164/**
Daniel Kingadc32c02016-05-16 18:25:45 -03003165 * \def MBEDTLS_POLY1305_C
3166 *
3167 * Enable the Poly1305 MAC algorithm.
3168 *
3169 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02003170 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03003171 */
3172#define MBEDTLS_POLY1305_C
3173
3174/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003175 * \def MBEDTLS_PSA_CRYPTO_C
3176 *
3177 * Enable the Platform Security Architecture cryptography API.
3178 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003179 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003180 *
Valerio Setti7ab90722023-11-23 16:29:51 +01003181 * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003182 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Valerio Settid5cab812023-12-28 10:04:51 +01003183 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
3184 * Auto-enables: MBEDTLS_CIPHER_C if any unauthenticated (ie, non-AEAD) cipher
3185 * is enabled in PSA (unless it's fully accelerated, see
3186 * docs/driver-only-builds.md about that).
Jaeden Amero484ee332018-10-25 17:38:05 +01003187 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003188#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003189
3190/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003191 * \def MBEDTLS_PSA_CRYPTO_SE_C
3192 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003193 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003194 * cryptography API.
3195 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003196 * \deprecated This feature is deprecated. Please switch to the PSA driver
3197 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003198 *
Ryan Everett32a64582024-03-05 18:16:18 +00003199 * \warning This feature is not thread-safe, and should not be used in a
3200 * multi-threaded environment.
3201 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003202 * Module: library/psa_crypto_se.c
3203 *
3204 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3205 *
3206 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003207//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003208
3209/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003210 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3211 *
3212 * Enable the Platform Security Architecture persistent key storage.
3213 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003214 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003215 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003216 * Requires: MBEDTLS_PSA_CRYPTO_C,
3217 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3218 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003219 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003220#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003221
3222/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003223 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003224 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003225 * Enable the emulation of the Platform Security Architecture
3226 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003227 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003228 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003229 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003230 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003231 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003232#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003233
3234/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003236 *
3237 * Enable the RIPEMD-160 hash algorithm.
3238 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003239 * Module: library/ripemd160.c
3240 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003241 *
3242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003244
3245/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003247 *
3248 * Enable the RSA public-key cryptosystem.
3249 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003251 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003252 * Caller: library/pk.c
3253 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003255 * library/ssl*_client.c
3256 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003258 * This module is used by the following key exchanges:
3259 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003260 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003261 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003264
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003267 *
3268 * Enable the SHA1 cryptographic hash algorithm.
3269 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003270 * Module: library/sha1.c
3271 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003272 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003273 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003274 * This module is required for TLS 1.2 depending on the handshake parameters,
3275 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003276 *
3277 * \warning SHA-1 is considered a weak message digest and its use constitutes
3278 * a security risk. If possible, we recommend avoiding dependencies
3279 * on it, and considering stronger message digests instead.
3280 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003283
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003284/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003285 * \def MBEDTLS_SHA224_C
3286 *
3287 * Enable the SHA-224 cryptographic hash algorithm.
3288 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003289 * Module: library/sha256.c
3290 * Caller: library/md.c
3291 * library/ssl_cookie.c
3292 *
3293 * This module adds support for SHA-224.
3294 */
3295#define MBEDTLS_SHA224_C
3296
3297/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003299 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003300 * Enable the SHA-256 cryptographic hash algorithm.
3301 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003302 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003303 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003304 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003305 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003306 * library/ssl*_client.c
3307 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003308 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003309 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003310 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003314/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003315 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003316 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003317 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3318 * with the ARMv8 cryptographic extensions if they are available at runtime.
3319 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003320 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003321 * \note If MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT is defined when building
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003322 * for a non-Armv8-A build it will be silently ignored.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003323 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003324 * \note Minimum compiler versions for this feature are Clang 4.0,
3325 * armclang 6.6 or GCC 6.0.
3326 *
3327 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3328 * armclang <= 6.9
3329 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003330 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3331 * That name is deprecated, but may still be used as an alternative form for this
3332 * option.
3333 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003334 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT cannot be defined at the
3335 * same time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003336 *
3337 * Requires: MBEDTLS_SHA256_C.
3338 *
3339 * Module: library/sha256.c
3340 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003341 * Uncomment to have the library check for the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003342 * and use them if available.
3343 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003344//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Dave Rodgman94a634d2023-10-10 12:59:29 +01003345
Dave Rodgmand85277c2023-10-13 09:22:54 +01003346/**
3347 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3348 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003349 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003350 * This name is now deprecated, but may still be used as an alternative form for
3351 * this option.
3352 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003353//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3354
3355/**
Dave Rodgman5b89c552023-10-10 14:59:02 +01003356 * \def MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003357 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003358 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3359 * with the ARMv8 cryptographic extensions, which must be available at runtime
3360 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003361 *
3362 * \note This allows builds with a smaller code size than with
Dave Rodgman5b89c552023-10-10 14:59:02 +01003363 * MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003364 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003365 * \note Minimum compiler versions for this feature are Clang 4.0,
3366 * armclang 6.6 or GCC 6.0.
3367 *
3368 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3369 * armclang <= 6.9
3370 *
Dave Rodgman94a634d2023-10-10 12:59:29 +01003371 * \note This was previously known as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
Dave Rodgman7821df32023-10-13 09:38:44 +01003372 * That name is deprecated, but may still be used as an alternative form for this
Dave Rodgman94a634d2023-10-10 12:59:29 +01003373 * option.
3374 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003375 * \warning MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY cannot be defined at the same
3376 * time as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003377 *
3378 * Requires: MBEDTLS_SHA256_C.
3379 *
3380 * Module: library/sha256.c
3381 *
Dave Rodgmanf097bef2023-10-10 14:56:35 +01003382 * Uncomment to have the library use the Armv8-A SHA-256 crypto extensions
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003383 * unconditionally.
3384 */
Dave Rodgman5b89c552023-10-10 14:59:02 +01003385//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Dave Rodgman94a634d2023-10-10 12:59:29 +01003386
Dave Rodgmand85277c2023-10-13 09:22:54 +01003387/**
3388 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3389 *
Dave Rodgman5b89c552023-10-10 14:59:02 +01003390 * \deprecated This is now known as MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY.
Dave Rodgman94a634d2023-10-10 12:59:29 +01003391 * This name is now deprecated, but may still be used as an alternative form for
3392 * this option.
3393 */
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003394//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3395
3396/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003397 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003398 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003399 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003400 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003401 * Module: library/sha512.c
3402 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003403 * library/psa_crypto_hash.c
3404 * library/ssl_tls.c
3405 * library/ssl*_client.c
3406 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003407 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003408 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003409 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003410#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003411
3412/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003414 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003415 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003416 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003417 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003418 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003419 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003420 * library/ssl_tls.c
3421 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003422 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003423 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003426
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003427/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003428 * \def MBEDTLS_SHA3_C
3429 *
3430 * Enable the SHA3 cryptographic hash algorithm.
3431 *
3432 * Module: library/sha3.c
3433 *
3434 * This module adds support for SHA3.
3435 */
3436#define MBEDTLS_SHA3_C
3437
3438/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003439 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3440 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003441 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3442 * with the ARMv8 cryptographic extensions if they are available at runtime.
3443 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003444 *
3445 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3446 * for a non-Aarch64 build it will be silently ignored.
3447 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003448 * \note Minimum compiler versions for this feature are Clang 7.0,
3449 * armclang 6.9 or GCC 8.0.
3450 *
3451 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3452 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003453 *
3454 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3455 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3456 *
3457 * Requires: MBEDTLS_SHA512_C.
3458 *
3459 * Module: library/sha512.c
3460 *
3461 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3462 * and use them if available.
3463 */
3464//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3465
3466/**
3467 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3468 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003469 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3470 * with the ARMv8 cryptographic extensions, which must be available at runtime
3471 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003472 *
3473 * \note This allows builds with a smaller code size than with
3474 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3475 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003476 * \note Minimum compiler versions for this feature are Clang 7.0,
3477 * armclang 6.9 or GCC 8.0.
3478 *
3479 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3480 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003481 *
3482 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3483 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3484 *
3485 * Requires: MBEDTLS_SHA512_C.
3486 *
3487 * Module: library/sha512.c
3488 *
3489 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3490 * unconditionally.
3491 */
3492//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3493
3494/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003496 *
3497 * Enable simple SSL cache implementation.
3498 *
3499 * Module: library/ssl_cache.c
3500 * Caller:
3501 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003505
3506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003508 *
3509 * Enable basic implementation of DTLS cookies for hello verification.
3510 *
3511 * Module: library/ssl_cookie.c
3512 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003515
3516/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003517 * \def MBEDTLS_SSL_TICKET_C
3518 *
3519 * Enable an implementation of TLS server-side callbacks for session tickets.
3520 *
3521 * Module: library/ssl_ticket.c
3522 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003523 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003524 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3525 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003526 */
3527#define MBEDTLS_SSL_TICKET_C
3528
3529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003530 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003531 *
3532 * Enable the SSL/TLS client code.
3533 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003534 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003535 * Caller:
3536 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003538 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003539 * This module is required for SSL/TLS client support.
3540 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003542
Paul Bakker9a736322012-11-14 12:39:52 +00003543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003545 *
3546 * Enable the SSL/TLS server code.
3547 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003548 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003549 * Caller:
3550 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003552 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003553 * This module is required for SSL/TLS server support.
3554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003556
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003559 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003560 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003561 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003562 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003563 * Caller: library/ssl*_client.c
3564 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003565 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3567 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003568 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003569 * This module is required for SSL/TLS.
3570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003572
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003573/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003575 *
3576 * Enable the threading abstraction layer.
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003577 * By default Mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003578 * contexts are not shared between threads. If you do intend to use contexts
3579 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003580 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003581 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003582 *
3583 * Module: library/threading.c
3584 *
3585 * This allows different threading implementations (self-implemented or
3586 * provided).
3587 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588 * You will have to enable either MBEDTLS_THREADING_ALT or
3589 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003590 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003591 * Enable this layer to allow use of mutexes within Mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003592 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003594
3595/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003597 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003598 * Enable the semi-portable timing interface.
3599 *
Simon Butcherd567a232016-03-09 20:19:21 +00003600 * \note The provided implementation only works on POSIX/Unix (including Linux,
3601 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003602 * module and provide your own implementations of the callbacks needed by
3603 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3604 * your own implementation of the whole module by setting
3605 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003606 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003607 * \note The timing module will include time.h on suitable platforms
3608 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3609 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3610 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003611 * \note See also our Knowledge Base article about porting to a new
3612 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003613 * 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 +00003614 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003615 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003617#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003618
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003619/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003620 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003621 *
3622 * Enable run-time version information.
3623 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003624 * Module: library/version.c
3625 *
3626 * This module provides run-time version information.
3627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003629
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003630/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003631 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003632 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003633 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003634 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003635 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003636 * Caller: library/x509_crl.c
3637 * library/x509_crt.c
3638 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003639 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003640 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003641 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3642 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003643 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3644 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003645 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003646 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003649
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003652 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003653 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003654 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003655 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003656 * Caller: library/ssl_tls.c
3657 * library/ssl*_client.c
3658 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003659 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003660 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003661 *
3662 * This module is required for X.509 certificate parsing.
3663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003664#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003665
3666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003667 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003668 *
3669 * Enable X.509 CRL parsing.
3670 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003671 * Module: library/x509_crl.c
3672 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003673 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003675 *
3676 * This module is required for X.509 CRL parsing.
3677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003678#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003679
3680/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003682 *
3683 * Enable X.509 Certificate Signing Request (CSR) parsing.
3684 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003685 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003686 * Caller: library/x509_crt_write.c
3687 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003688 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003689 *
3690 * This module is used for reading X.509 certificate request.
3691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003692#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003693
3694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003695 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003696 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003697 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003698 *
3699 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003700 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003701 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003702 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3703 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003704 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3705 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003706 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003707 * This module is the basis for creating X.509 certificates and CSRs.
3708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003710
3711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003713 *
3714 * Enable creating X.509 certificates.
3715 *
3716 * Module: library/x509_crt_write.c
3717 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003719 *
3720 * This module is required for X.509 certificate creation.
3721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003722#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003723
3724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003725 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003726 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003727 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003728 *
3729 * Module: library/x509_csr_write.c
3730 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003732 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003733 * This module is required for X.509 certificate request writing.
3734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003735#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003736
Gilles Peskinee820c0a2023-08-03 17:45:20 +02003737/** \} name SECTION: Mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003738
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003739/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003740 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003741 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003742 * This section contains Mbed TLS build settings that are not associated
3743 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003744 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003745 * \{
3746 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003747
Gilles Peskinea02c1242022-03-16 17:03:19 +01003748/**
3749 * \def MBEDTLS_CONFIG_FILE
3750 *
3751 * If defined, this is a header which will be included instead of
3752 * `"mbedtls/mbedtls_config.h"`.
3753 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003754 * Unlike other configuration options, this one must be defined on the
3755 * compiler command line: a definition in `mbedtls_config.h` would have
3756 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003757 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003758 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003759 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003760 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003761 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003762 * The value of this symbol is typically a path in double quotes, either
3763 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003764 */
3765//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3766
3767/**
3768 * \def MBEDTLS_USER_CONFIG_FILE
3769 *
3770 * If defined, this is a header which will be included after
3771 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003772 * This allows you to modify the default configuration, including the ability
3773 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003774 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003775 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003776 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003777 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003778 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003779 * The value of this symbol is typically a path in double quotes, either
3780 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003781 */
3782//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3783
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003784/**
3785 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3786 *
3787 * If defined, this is a header which will be included instead of
3788 * `"psa/crypto_config.h"`.
3789 * This header file specifies which cryptographic mechanisms are available
3790 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3791 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3792 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003793 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003794 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003795 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003796 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003797 * The value of this symbol is typically a path in double quotes, either
3798 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003799 */
3800//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3801
3802/**
3803 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3804 *
3805 * If defined, this is a header which will be included after
3806 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003807 * This allows you to modify the default configuration, including the ability
3808 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003809 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003810 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003811 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003812 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003813 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003814 * The value of this symbol is typically a path in double quotes, either
3815 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003816 */
3817//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3818
Gilles Peskineb1176f22023-02-22 22:07:28 +01003819/**
3820 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3821 *
3822 * If defined, this is a header which will be included instead of
3823 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3824 * as the one in Mbed TLS, but with definitions adapted to the platform on
3825 * which the library code will run.
3826 *
3827 * \note The required content of this header can vary from one version of
3828 * Mbed TLS to the next. Integrators who provide an alternative file
3829 * should review the changes in the original file whenever they
3830 * upgrade Mbed TLS.
3831 *
3832 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3833 * non-standard feature of the C language, so this feature is only available
3834 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3835 *
3836 * The value of this symbol is typically a path in double quotes, either
3837 * absolute or relative to a directory on the include search path.
3838 */
3839//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3840
3841/**
3842 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3843 *
3844 * If defined, this is a header which will be included instead of
3845 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3846 * as the one in Mbed TLS, but with definitions adapted to the environment
3847 * in which the library code will run. The typical use for this feature
3848 * is to provide alternative type definitions on the client side in
3849 * client-server integrations of PSA crypto, where operation structures
3850 * contain handles instead of cryptographic data.
3851 *
3852 * \note The required content of this header can vary from one version of
3853 * Mbed TLS to the next. Integrators who provide an alternative file
3854 * should review the changes in the original file whenever they
3855 * upgrade Mbed TLS.
3856 *
3857 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3858 * non-standard feature of the C language, so this feature is only available
3859 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3860 *
3861 * The value of this symbol is typically a path in double quotes, either
3862 * absolute or relative to a directory on the include search path.
3863 */
3864//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3865
Gilles Peskineba4162a2022-04-11 17:04:38 +02003866/** \} name SECTION: General configuration options */
3867
3868/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003869 * \name SECTION: Module configuration options
3870 *
3871 * This section allows for the setting of module specific sizes and
3872 * configuration options. The default values are already present in the
3873 * relevant header files and should suffice for the regular use cases.
3874 *
3875 * Our advice is to enable options and change their values here
3876 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003877 * \{
3878 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003879/* The Doxygen documentation here is used when a user comments out a
3880 * setting and runs doxygen themselves. On the other hand, when we typeset
3881 * the full documentation including disabled settings, the documentation
3882 * in specific modules' header files is used if present. When editing this
3883 * file, make sure that each option is documented in exactly one place,
3884 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3885 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003886
Paul Bakker088c5c52014-04-25 11:11:10 +02003887/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003888//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003890
Paul Bakker088c5c52014-04-25 11:11:10 +02003891/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003892//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3893//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3894//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3895//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3896//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003897
Paul Bakker088c5c52014-04-25 11:11:10 +02003898/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003899//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3900//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3901//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3902//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003903
Paul Bakker088c5c52014-04-25 11:11:10 +02003904/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003905//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003906//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003907
Paul Bakker088c5c52014-04-25 11:11:10 +02003908/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003909//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3910//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003911//#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 +01003912
Paul Bakker088c5c52014-04-25 11:11:10 +02003913/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003914//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003915
Paul Bakker088c5c52014-04-25 11:11:10 +02003916/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003917//#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 -04003918
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003919/** \def MBEDTLS_PLATFORM_STD_CALLOC
3920 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003921 * Default allocator to use, can be undefined.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003922 * It must initialize the allocated buffer memory to zeroes.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003923 * The size of the buffer is the product of the two parameters.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003924 * The calloc function returns either a null pointer or a pointer to the allocated space.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003925 * 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 -04003926 * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer.
3927 * See the description of #MBEDTLS_PLATFORM_MEMORY for more details.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003928 * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003929 */
3930//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -04003931
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003932/** \def MBEDTLS_PLATFORM_STD_FREE
3933 *
Andrzej Kurekf14a5c32023-07-14 06:15:15 -04003934 * Default free to use, can be undefined.
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003935 * NULL is a valid parameter, and the function must do nothing.
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003936 * 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 -04003937 * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything.
3938 * 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 -04003939 */
3940//#define MBEDTLS_PLATFORM_STD_FREE free
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003941//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003942//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003943//#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 +02003944//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3945//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003946/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003947//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003948//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3949//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003950//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3951//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3952//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003953
Andrzej Kurekecaf6fb2023-05-04 17:07:57 -04003954/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003955/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Andrzej Kurek2d981f02023-04-27 09:19:35 -04003956//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */
3957//#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 +02003958//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003959//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003960//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3961//#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 +02003962//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3963//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003964/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003966//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003967//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3968//#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 +08003969//#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 +08003970//#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 +02003971
Gilles Peskine3f106f72021-09-23 17:42:39 +02003972/** \def MBEDTLS_CHECK_RETURN
3973 *
3974 * This macro is used at the beginning of the declaration of a function
3975 * to indicate that its return value should be checked. It should
3976 * instruct the compiler to emit a warning or an error if the function
3977 * is called without checking its return value.
3978 *
3979 * There is a default implementation for popular compilers in platform_util.h.
3980 * You can override the default implementation by defining your own here.
3981 *
3982 * If the implementation here is empty, this will effectively disable the
3983 * checking of functions' return values.
3984 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003985//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003986
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003987/** \def MBEDTLS_IGNORE_RETURN
3988 *
3989 * This macro requires one argument, which should be a C function call.
3990 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3991 * warning is suppressed.
3992 */
3993//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3994
Gilles Peskineed038902020-11-13 21:33:21 +01003995/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003996/**
Gilles Peskineed038902020-11-13 21:33:21 +01003997 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3998 * PSA crypto subsystem.
3999 *
4000 * If this option is unset:
4001 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01004002 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01004003 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
4004 * on unspecified heuristics.
4005 */
4006//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
4007
Steven Cooreman863470a2021-02-15 14:03:19 +01004008/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004009 * Restrict the PSA library to supporting a maximum amount of simultaneously
4010 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
4011 * volatile key, or a persistent key which is loaded temporarily by the
4012 * library as part of a crypto operation in flight.
4013 *
4014 * If this option is unset, the library will fall back to a default value of
4015 * 32 keys.
4016 */
Steven Cooreman863470a2021-02-15 14:03:19 +01004017//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01004018
Waleed Elmelegyd7bdbbe2023-07-20 16:26:58 +00004019/* RSA OPTIONS */
Gilles Peskinef9e4caf2023-09-05 21:11:27 +02004020//#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 +00004021
Paul Bakker088c5c52014-04-25 11:11:10 +02004022/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004023//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
4024//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02004025
Paul Bakker088c5c52014-04-25 11:11:10 +02004026/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10004027
Angus Grattond8213d02016-05-25 20:56:48 +10004028/** \def MBEDTLS_SSL_IN_CONTENT_LEN
4029 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004030 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004031 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004032 * This determines the size of the incoming TLS I/O buffer in such a way
4033 * that it is capable of holding the specified amount of plaintext data,
4034 * regardless of the protection mechanism used.
4035 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004036 * \note When using a value less than the default of 16KB on the client, it is
4037 * recommended to use the Maximum Fragment Length (MFL) extension to
4038 * inform the server about this limitation. On the server, there
4039 * is no supported, standardized way of informing the client about
4040 * restriction on the maximum size of incoming messages, and unless
4041 * the limitation has been communicated by other means, it is recommended
4042 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
4043 * while keeping the default value of 16KB for the incoming buffer.
4044 *
David Horstmann95d516f2021-05-04 18:36:56 +01004045 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004046 */
4047//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
4048
Gilles Peskined3d02902020-03-04 21:35:27 +01004049/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
4050 *
4051 * The maximum length of CIDs used for incoming DTLS messages.
4052 *
4053 */
4054//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
4055
4056/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
4057 *
4058 * The maximum length of CIDs used for outgoing DTLS messages.
4059 *
4060 */
4061//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
4062
TRodziewicze8dd7092021-05-12 14:19:11 +02004063/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01004064 *
4065 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02004066 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01004067 *
4068 * The padding will always be chosen so that the length of the
4069 * padded plaintext is a multiple of the value of this option.
4070 *
4071 * Note: A value of \c 1 means that no padding will be used
4072 * for outgoing records.
4073 *
4074 * Note: On systems lacking division instructions,
4075 * a power of two should be preferred.
4076 */
TRodziewicze8dd7092021-05-12 14:19:11 +02004077//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01004078
Angus Grattond8213d02016-05-25 20:56:48 +10004079/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
4080 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004081 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10004082 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05004083 * This determines the size of the outgoing TLS I/O buffer in such a way
4084 * that it is capable of holding the specified amount of plaintext data,
4085 * regardless of the protection mechanism used.
4086 *
Angus Grattond8213d02016-05-25 20:56:48 +10004087 * It is possible to save RAM by setting a smaller outward buffer, while keeping
4088 * the default inward 16384 byte buffer to conform to the TLS specification.
4089 *
4090 * The minimum required outward buffer size is determined by the handshake
4091 * protocol's usage. Handshaking will fail if the outward buffer is too small.
4092 * The specific size requirement depends on the configured ciphers and any
4093 * certificate data which is sent during the handshake.
4094 *
David Horstmann95d516f2021-05-04 18:36:56 +01004095 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10004096 */
4097//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
4098
Hanno Beckere0b150f2018-08-21 15:51:03 +01004099/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
4100 *
4101 * Maximum number of heap-allocated bytes for the purpose of
4102 * DTLS handshake message reassembly and future message buffering.
4103 *
Yuto Takano7828ca22021-08-10 11:26:15 +01004104 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01004105 * to account for a reassembled handshake message of maximum size,
4106 * together with its reassembly bitmap.
4107 *
Hanno Becker97a1c132018-08-28 14:42:15 +01004108 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01004109 * should be sufficient for all practical situations as it allows
4110 * to reassembly a large handshake message (such as a certificate)
4111 * while buffering multiple smaller handshake messages.
4112 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01004113 */
Hanno Becker159a37f2018-08-24 15:07:29 +01004114//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01004115
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01004116//#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 +02004117//#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 +02004118
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02004119/**
4120 * Complete list of ciphersuites to use, in order of preference.
4121 *
4122 * \warning No dependency checking is done on that field! This option can only
4123 * be used to restrict the set of available ciphersuites. It is your
4124 * responsibility to make sure the needed modules are active.
4125 *
4126 * Use this to save a few hundred bytes of ROM (default ordering of all
4127 * available ciphersuites) and a few to a few hundred bytes of RAM.
4128 *
4129 * The value below is only an example, not the default.
4130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004131//#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 +02004132
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004133/**
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004134 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
4135 *
4136 * The default maximum amount of 0-RTT data. See the documentation of
Yanray Wang07517612023-11-07 11:47:36 +08004137 * \c mbedtls_ssl_conf_max_early_data_size() for more information.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004138 *
4139 * It must be positive and smaller than UINT32_MAX.
4140 *
4141 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
4142 * have any impact on the build.
Tom Cosgrovea63775b2023-09-14 13:31:19 +01004143 */
4144//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
4145
4146/**
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004147 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
4148 *
Jerry Yucf913512023-11-14 11:06:52 +08004149 * Maximum allowed ticket age difference in milliseconds tolerated between
Jerry Yu034a8b72023-11-10 12:20:19 +08004150 * server and client. Default value is 6000. This is not used in TLS 1.2.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004151 *
Jerry Yu034a8b72023-11-10 12:20:19 +08004152 * - The client ticket age is the time difference between the time when the
4153 * client proposes to the server to use the ticket and the time the client
4154 * received the ticket from the server.
4155 * - The server ticket age is the time difference between the time when the
4156 * server receives a proposition from the client to use the ticket and the
4157 * time when the ticket was created by the server.
4158 *
Jerry Yucf913512023-11-14 11:06:52 +08004159 * The ages might be different due to the client and server clocks not running
4160 * at the same pace. The typical accuracy of an RTC crystal is ±100 to ±20 parts
4161 * per million (360 to 72 milliseconds per hour). Default tolerance window is
4162 * 6s, thus in the worst case clients and servers must sync up their system time
4163 * every 6000/360/2~=8 hours.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004164 *
Jerry Yu04fceb72023-11-15 09:52:46 +08004165 * See section 8.3 of the TLS 1.3 specification(RFC 8446) for more information.
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004166 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004167//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004168
4169/**
4170 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
4171 *
4172 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
4173 *
4174 * This must be less than 256.
4175 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004176//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004177
4178/**
4179 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
4180 *
4181 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
4182 * after handshake completion. This is not used in TLS 1.2 and relevant only if
4183 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
4184 *
4185 */
Gilles Peskined65ea422023-09-05 21:07:32 +02004186//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Gilles Peskinea8d7e432022-08-04 23:39:41 +02004187
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01004188/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004189//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01004190//#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 +01004191
Gilles Peskine611179c2022-04-13 23:04:48 +02004192/** \} name SECTION: Module configuration options */