blob: e8b909d0b266d7198db24a161c0a3ed72470ef58 [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
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000051 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010052 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000053 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000054 * library/constant_time.c
55 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000056 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010057 * Required by:
58 * MBEDTLS_AESNI_C
59 * MBEDTLS_PADLOCK_C
60 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020061 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000062 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020063#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000064
Paul Bakkerf3b86c12011-01-27 15:24:17 +000065/**
Gilles Peskineed942f82017-06-08 15:19:20 +020066 * \def MBEDTLS_NO_UDBL_DIVISION
67 *
68 * The platform lacks support for double-width integer division (64-bit
69 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
70 *
71 * Used in:
72 * include/mbedtls/bignum.h
73 * library/bignum.c
74 *
75 * The bignum code uses double-width division to speed up some operations.
76 * Double-width division is often implemented in software that needs to
77 * be linked with the program. The presence of a double-width integer
78 * type is usually detected automatically through preprocessor macros,
79 * but the automatic detection cannot know whether the code needs to
80 * and can be linked with an implementation of division for that type.
81 * By default division is assumed to be usable if the type is present.
82 * Uncomment this option to prevent the use of double-width division.
83 *
84 * Note that division for the native integer type is always required.
85 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010086 * platform, but it need not support multiplication or division. In some
87 * cases it is also desirable to disable some double-width operations. For
88 * example, if double-width division is implemented in software, disabling
89 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020090 */
91//#define MBEDTLS_NO_UDBL_DIVISION
92
93/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020094 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
95 *
96 * The platform lacks support for 32x32 -> 64-bit multiplication.
97 *
98 * Used in:
99 * library/poly1305.c
100 *
101 * Some parts of the library may use multiplication of two unsigned 32-bit
102 * operands with a 64-bit result in order to speed up computations. On some
103 * platforms, this is not available in hardware and has to be implemented in
104 * software, usually in a library provided by the toolchain.
105 *
106 * Sometimes it is not desirable to have to link to that library. This option
107 * removes the dependency of that library on platforms that lack a hardware
108 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
109 *
110 * Note that depending on the compiler, this may decrease performance compared
111 * to using the library function provided by the toolchain.
112 */
113//#define MBEDTLS_NO_64BIT_MULTIPLICATION
114
115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200116 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000117 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000118 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000119 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000120 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200123
124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200125 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200126 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200127 * System has time.h and time().
128 * The time does not need to be correct, only time differences are used,
129 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200130 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100131 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
132 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
133 * MBEDTLS_PLATFORM_STD_TIME.
134 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400135 * Comment if your system does not support time functions.
136 *
137 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
138 * interface - timing.c will include time.h on suitable platforms
139 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
140 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100143
144/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200145 * \def MBEDTLS_HAVE_TIME_DATE
146 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100147 * System has time.h, time(), and an implementation for
148 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100149 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200150 * the date should be correct). This is used to verify the validity period of
151 * X.509 certificates.
152 *
153 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100154 *
Hanno Becker6a739782018-09-05 15:06:19 +0100155 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100156 * behaves similarly to the gmtime_r() function from the C standard. Refer to
157 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100158 *
159 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100160 * mbedtls_platform_gmtime_r() at compile-time by using the macro
161 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200162 */
163#define MBEDTLS_HAVE_TIME_DATE
164
165/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100167 *
168 * Enable the memory allocation layer.
169 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200170 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100171 * This allows different allocators (self-implemented or provided) to be
172 * provided to the platform abstraction layer.
173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200175 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
176 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000177 * free() function pointer at runtime.
178 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200180 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000181 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100182 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100184 *
185 * Enable this layer to allow use of alternative memory allocators.
186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100188
189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200192 * Do not assign standard functions in the platform layer (e.g. calloc() to
193 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200194 *
195 * This makes sure there are no linking errors on platforms that do not support
196 * these functions. You will HAVE to provide alternatives, either at runtime
197 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
199 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200200 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200201 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200202 *
203 * Uncomment to prevent default assignment of standard functions in the
204 * platform layer.
205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200207
208/**
Janos Follathc351d182016-03-21 08:43:59 +0000209 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100211 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
212 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
215 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100216 * alternative printf function pointer.
217 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200218 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100219 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200220 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
221 * it will be enabled automatically by check_config.h
222 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200223 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000225 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100226 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
227 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100228 * Uncomment a macro to enable alternate implementation of specific base
229 * platform function
230 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200231//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100233//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234//#define MBEDTLS_PLATFORM_FPRINTF_ALT
235//#define MBEDTLS_PLATFORM_PRINTF_ALT
236//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200237//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100238//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100239//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100240
241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000244 * Mark deprecated functions and features so that they generate a warning if
245 * used. Functionality deprecated in one version will usually be removed in the
246 * next version. You can enable this to help you prepare the transition to a
247 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
249 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200250 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100251 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000252 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255
256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100258 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000259 * Remove deprecated functions and features so that they generate an error if
260 * used. Functionality deprecated in one version will usually be removed in the
261 * next version. You can enable this to help you prepare the transition to a
262 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100263 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000264 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200266//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100267
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100268/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000269
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000270/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000271 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000272 *
273 * This section sets support for features that are or are not needed
274 * within the modules that are enabled.
275 * \{
276 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000277
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200279 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100280 *
TRodziewiczd8540832021-06-10 15:16:50 +0200281 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200282 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100283 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100285 *
286 * You will need to provide a header "timing_alt.h" and an implementation at
287 * compile time.
288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200289//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100290
291/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100292 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200293 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100294 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100295 * alternate core implementation of a symmetric crypto, an arithmetic or hash
296 * module (e.g. platform specific assembly optimized implementations). Keep
297 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200298 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200299 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200301 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000303 * provide the "struct mbedtls_aes_context" definition and omit the base
304 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200305 * "aes.h" to include the new function definitions.
306 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200307 * Uncomment a macro to enable alternate implementation of the corresponding
308 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100309 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200310 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100311 * use constitutes a security risk. If possible, we recommend
312 * avoiding dependencies on them, and considering stronger message
313 * digests and ciphers instead.
314 *
Paul Bakker90995b52013-06-24 19:20:35 +0200315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000317//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200319//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300320//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200321//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200322//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000324//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000325//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100326//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300327//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300329//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000331//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332//#define MBEDTLS_SHA1_ALT
333//#define MBEDTLS_SHA256_ALT
334//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000335
Janos Follathb0697532016-08-18 12:38:46 +0100336/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800337 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100338 * implemented with two .c files:
339 * - ecp.c
340 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000341 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
342 * macros as described above. The only difference is that you have to make sure
343 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100344 */
345//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200346
347/**
TRodziewicz75628d52021-06-18 12:56:27 +0200348 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200349 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100350 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
351 * alternate core implementation of symmetric crypto or hash function. Keep in
352 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200353 *
354 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200355 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200356 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
358 * no longer provide the mbedtls_sha1_process() function, but it will still provide
359 * the other function (using your mbedtls_sha1_process() function) and the definition
360 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200361 * with this definition.
362 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200363 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100364 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
365 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200366 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200367 * Uncomment a macro to enable alternate implementation of the corresponding
368 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100369 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200370 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 * constitutes a security risk. If possible, we recommend avoiding
372 * dependencies on them, and considering stronger message digests
373 * and ciphers instead.
374 *
Janos Follath1231d212019-01-07 15:01:32 +0000375 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
376 * enabled, then the deterministic ECDH signature functions pass the
377 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
378 * alternative implementations should use the RNG only for generating
379 * the ephemeral key and nothing else. If this is not possible, then
380 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200381 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000382 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384//#define MBEDTLS_MD5_PROCESS_ALT
385//#define MBEDTLS_RIPEMD160_PROCESS_ALT
386//#define MBEDTLS_SHA1_PROCESS_ALT
387//#define MBEDTLS_SHA256_PROCESS_ALT
388//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200389//#define MBEDTLS_DES_SETKEY_ALT
390//#define MBEDTLS_DES_CRYPT_ECB_ALT
391//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200392//#define MBEDTLS_AES_SETKEY_ENC_ALT
393//#define MBEDTLS_AES_SETKEY_DEC_ALT
394//#define MBEDTLS_AES_ENCRYPT_ALT
395//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300396//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300397//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300398//#define MBEDTLS_ECDSA_VERIFY_ALT
399//#define MBEDTLS_ECDSA_SIGN_ALT
400//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200401
402/**
Janos Follathc44ab972016-11-18 16:38:23 +0000403 * \def MBEDTLS_ECP_INTERNAL_ALT
404 *
405 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100406 *
407 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100408 * alternative core implementation of elliptic curve arithmetic. Keep in mind
409 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100410 *
411 * This partially replaces one function. The header file from mbed TLS is still
412 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
413 * is still present and it is used for group structures not supported by the
414 * alternative.
415 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100416 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100417 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100418 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
419 * able to fallback to curves not supported by the alternative implementation.
420 *
Janos Follathc44ab972016-11-18 16:38:23 +0000421 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
422 * and implementing the following functions:
423 * unsigned char mbedtls_internal_ecp_grp_capable(
424 * const mbedtls_ecp_group *grp )
425 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500426 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000427 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
428 * replacement functions implement arithmetic for the given group and 0
429 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500430 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000431 * called before and after each point operation and provide an opportunity to
432 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100433 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100434 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
435 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
436 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
437 * for the operation is supported by your implementation (i.e. your
438 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
439 * group is not supported by your implementation, then the original mbed TLS
440 * implementation of ecp_double_jac() is used instead, unless this fallback
441 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
442 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
443 *
444 * The function prototypes and the definition of mbedtls_ecp_group and
445 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
446 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
447 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100448 *
449 * Uncomment a macro to enable alternate implementation of the corresponding
450 * function.
451 */
452/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000453//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100454/* Turn off software fallback for curves not supported in hardware */
455//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100456/* Support for Weierstrass curves with Jacobi representation */
457//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
458//#define MBEDTLS_ECP_ADD_MIXED_ALT
459//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
460//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
461//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
462/* Support for curves with Montgomery arithmetic */
463//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
464//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
465//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
466
467/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200468 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200469 *
470 * Uncomment this macro to let mbed TLS use your own implementation of a
471 * hardware entropy collector.
472 *
473 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000474 * prototype as declared in library/entropy_poll.h, and accept NULL as first
475 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200476 *
477 * Uncomment to use your own hardware entropy collector.
478 */
479//#define MBEDTLS_ENTROPY_HARDWARE_ALT
480
481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000483 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100484 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000485 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100486 * Uncomment this macro to use precomputed AES tables stored in ROM.
487 * Comment this macro to generate AES tables in RAM at runtime.
488 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100489 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
490 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100491 * initialization time before the first AES operation can be performed.
492 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
493 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
494 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100495 *
496 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
497 *
Paul Bakker15566e42011-04-24 21:19:15 +0000498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200499//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000500
501/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100502 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200503 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100504 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200505 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100506 * Uncommenting this macro omits 75% of the AES tables from
507 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
508 * by computing their values on the fly during operations
509 * (the tables are entry-wise rotations of one another).
510 *
511 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100512 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100513 * runtime. Specifically, one has to compare 4 accesses within
514 * different tables to 4 accesses with additional arithmetic
515 * operations within the same table. The performance gain/loss
516 * depends on the system and memory details.
517 *
518 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
519 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200520 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100521//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200522
523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200525 *
526 * Use less ROM for the Camellia implementation (saves about 768 bytes).
527 *
528 * Uncomment this macro to use less memory for Camellia.
529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200530//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200531
532/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200533 * \def MBEDTLS_CHECK_RETURN_WARNING
534 *
535 * If this macro is defined, emit a compile-time warning if application code
536 * calls a function without checking its return value, but the return value
537 * should generally be checked in portable applications.
538 *
539 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
540 * implemented. Otherwise this option has no effect.
541 *
542 * Uncomment to get warnings on using fallible functions without checking
543 * their return value.
544 *
545 * \note This feature is a work in progress.
546 * Warnings will be added to more functions in the future.
547 *
548 * \note A few functions are considered critical, and ignoring the return
549 * value of these functions will trigger a warning even if this
550 * macro is not defined. To completely disable return value check
551 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
552 */
553//#define MBEDTLS_CHECK_RETURN_WARNING
554
555/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200557 *
558 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200561
562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000564 *
565 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000568
569/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000571 *
572 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000575
576/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100577 * \def MBEDTLS_CIPHER_MODE_OFB
578 *
579 * Enable Output Feedback mode (OFB) for symmetric ciphers.
580 */
581#define MBEDTLS_CIPHER_MODE_OFB
582
583/**
584 * \def MBEDTLS_CIPHER_MODE_XTS
585 *
586 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
587 */
588#define MBEDTLS_CIPHER_MODE_XTS
589
590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000592 *
593 * Enable NULL cipher.
594 * Warning: Only do so when you know what you are doing. This allows for
595 * encryption or channels without any security!
596 *
Ronald Croncee42702021-04-26 11:34:44 +0200597 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
599 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
600 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
601 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
602 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
603 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
604 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
605 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
606 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
607 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
608 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
609 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
610 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
611 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
612 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
613 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
614 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
615 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
616 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000617 *
618 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000621
622/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100623 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200624 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100625 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
626 * specific padding modes in the cipher layer with cipher modes that support
627 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200628 *
629 * If you disable all padding modes, only full blocks can be used with CBC.
630 *
631 * Enable padding modes in the cipher layer.
632 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633#define MBEDTLS_CIPHER_PADDING_PKCS7
634#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
635#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
636#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200637
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200638/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
639 *
640 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
641 * By default, CTR_DRBG uses a 256-bit key.
642 */
643//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
644
Paul Bakker48e93c82013-08-14 12:21:18 +0200645/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100646 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200647 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100648 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
649 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200650 *
651 * Comment macros to disable the curve and functions for it
652 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200653/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200654#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
655#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
656#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
657#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
658#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
659#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
660#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
661#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
662#define MBEDTLS_ECP_DP_BP256R1_ENABLED
663#define MBEDTLS_ECP_DP_BP384R1_ENABLED
664#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200665/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200666#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000667#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200668
669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200671 *
672 * Enable specific 'modulo p' routines for each NIST prime.
673 * Depending on the prime and architecture, makes operations 4 to 8 times
674 * faster on the corresponding curve.
675 *
676 * Comment this macro to disable NIST curves optimisation.
677 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200678#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200679
680/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200681 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100682 *
683 * Enable "non-blocking" ECC operations that can return early and be resumed.
684 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200685 * This allows various functions to pause by returning
686 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
687 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
688 * order to further progress and eventually complete their operation. This is
689 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
690 * number of ECC operations a function may perform before pausing; see
691 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100692 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200693 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200694 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100695 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100696 * This option:
697 * - Adds xxx_restartable() variants of existing operations in the
698 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100699 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
700 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100701 * - ECDSA: signature generation & verification;
702 * - PK: signature generation & verification;
703 * - X509: certificate chain verification.
704 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
705 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
706 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
707 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000708 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100709 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100710 * - verification of the server's key exchange signature;
711 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100712 * - generation of the client's signature if client authentication is used,
713 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100714 *
715 * \note In the cases above, the usual SSL/TLS functions, such as
716 * mbedtls_ssl_handshake(), can now return
717 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200718 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100719 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
720 * restartable operations in PK, X.509 and TLS (see above) are not
721 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100722 * PSA, and are not restartable. These are temporary limitations that
723 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200724 *
Ron Eldor19779c42018-11-05 16:58:13 +0200725 * \note This option only works with the default software implementation of
726 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100727 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100728 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100729 * Requires: MBEDTLS_ECP_C
730 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100731 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100732 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200733//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100734
735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100737 *
738 * Enable deterministic ECDSA (RFC 6979).
739 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
740 * may result in a compromise of the long-term signing key. This is avoided by
741 * the deterministic variant.
742 *
John Durkop36a82e52020-10-26 09:39:05 -0700743 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100744 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100745 * Comment this macro to disable deterministic ECDSA.
746 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100748
749/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200750 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200751 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200752 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200753 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200754 * This enables the following ciphersuites (if other requisites are
755 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200756 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
757 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
761 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
762 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
763 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
764 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
765 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200766 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200768
769/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200770 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200771 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200772 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
776 * This enables the following ciphersuites (if other requisites are
777 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
783 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
784 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
786 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
787 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100788 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100789 * \warning Using DHE constitutes a security risk as it
790 * is not possible to validate custom DH parameters.
791 * If possible, it is recommended users should consider
792 * preferring other methods of key exchange.
793 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100794 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200797
798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200799 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200800 *
801 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
802 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200804 *
805 * This enables the following ciphersuites (if other requisites are
806 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200815
816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200819 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200820 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
822 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200823 *
824 * This enables the following ciphersuites (if other requisites are
825 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
831 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
832 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
834 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
835 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838
839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200842 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
845 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200846 *
847 * This enables the following ciphersuites (if other requisites are
848 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
850 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
852 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
855 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
856 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
857 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
858 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
859 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863
864/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200867 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
870 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200871 *
872 * This enables the following ciphersuites (if other requisites are
873 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
877 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
880 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
883 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100886 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100887 * \warning Using DHE constitutes a security risk as it
888 * is not possible to validate custom DH parameters.
889 * If possible, it is recommended users should consider
890 * preferring other methods of key exchange.
891 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100892 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895
896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200897 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200899 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
902 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200903 *
904 * This enables the following ciphersuites (if other requisites are
905 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918
919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200921 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200922 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200923 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200925 *
926 * This enables the following ciphersuites (if other requisites are
927 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200940
941/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100943 *
944 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
945 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200946 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100962
963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 *
966 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
967 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200968 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100969 *
970 * This enables the following ciphersuites (if other requisites are
971 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
978 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
979 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
980 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
981 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100982 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200983#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100984
985/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200986 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
987 *
988 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
989 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200990 * \warning This is currently experimental. EC J-PAKE support is based on the
991 * Thread v1.0.0 specification; incompatible changes to the specification
992 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200993 *
994 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200995 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200996 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
997 *
998 * This enables the following ciphersuites (if other requisites are
999 * enabled as well):
1000 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1001 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001002//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003
1004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001005 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001006 *
1007 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1008 * RFC 5915 and RFC 5480.
1009 *
1010 * Currently this means parsing the SpecifiedECDomain choice of EC
1011 * parameters (only known groups are supported, not arbitrary domains, to
1012 * avoid validation issues).
1013 *
1014 * Disable if you only need to support RFC 5915 + 5480 key formats.
1015 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001020 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021 * Enable a dummy error function to make use of mbedtls_strerror() in
1022 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1023 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001024 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1026 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001027 *
1028 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001032
1033/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001035 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001036 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001041
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001044 *
1045 * Enable functions that use the filesystem.
1046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001048
1049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001051 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001052 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001053 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001054 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001055 * application.
1056 *
1057 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001060
1061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001063 *
1064 * Do not use built-in platform entropy functions.
1065 * This is useful if your platform does not support
1066 * standards like the /dev/urandom or Windows CryptoAPI.
1067 *
1068 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001071
1072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001074 *
1075 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1076 * default SHA-512 based one (if both are available).
1077 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001079 *
1080 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1081 * if you have performance concerns.
1082 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083 * This option is only useful if both MBEDTLS_SHA256_C and
1084 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001087
1088/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001089 * \def MBEDTLS_ENTROPY_NV_SEED
1090 *
1091 * Enable the non-volatile (NV) seed file-based entropy source.
1092 * (Also enables the NV seed read/write functions in the platform layer)
1093 *
1094 * This is crucial (if not required) on systems that do not have a
1095 * cryptographic entropy source (in hardware or kernel) available.
1096 *
1097 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1098 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001099 * \note The read/write functions that are used by the entropy source are
1100 * determined in the platform layer, and can be modified at runtime and/or
1101 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1102 *
1103 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001104 * with regular fopen(), please make sure you make a seedfile with the
1105 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1106 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001107 * and written to or you will get an entropy source error! The default
1108 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1109 * bytes from the file.
1110 *
1111 * \note The entropy collector will write to the seed file before entropy is
1112 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001113 */
1114//#define MBEDTLS_ENTROPY_NV_SEED
1115
Ronald Cron71016a92020-08-28 19:01:50 +02001116/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001117 *
Ronald Cron71016a92020-08-28 19:01:50 +02001118 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001119 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001120 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1121 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001122 *
1123 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001124 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001125 */
Ronald Cron71016a92020-08-28 19:01:50 +02001126//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001127
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001130 *
1131 * Enable debugging of buffer allocator memory issues. Automatically prints
1132 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1133 * function for 'debug output' of allocated memory.
1134 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001135 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001136 *
1137 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001140
1141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001143 *
1144 * Include backtrace information with each allocated block.
1145 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001146 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001147 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001148 *
1149 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001152
1153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001155 *
1156 * Support external private RSA keys (eg from a HSM) in the PK layer.
1157 *
1158 * Comment this macro to disable support for external private RSA keys.
1159 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001161
1162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001164 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001165 * Enable support for PKCS#1 v1.5 encoding.
1166 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001167 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001168 *
Paul Bakker48377d92013-08-30 12:06:24 +02001169 * This enables support for PKCS#1 v1.5 operations.
1170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001172
1173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001175 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001176 * Enable support for PKCS#1 v2.1 encoding.
1177 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001178 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1179 *
1180 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1181 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001182 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001183 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001184 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001185 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1186 * this module in builds where MBEDTLS_MD_C is disabled.
1187 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001188 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001191
Steven Cooreman6801f082021-02-19 17:21:22 +01001192/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1193 *
1194 * Enable support for platform built-in keys. If you enable this feature,
1195 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1196 * See the documentation of that function for more information.
1197 *
1198 * Built-in keys are typically derived from a hardware unique key or
1199 * stored in a secure element.
1200 *
1201 * Requires: MBEDTLS_PSA_CRYPTO_C.
1202 *
1203 * \warning This interface is experimental and may change or be removed
1204 * without notice.
1205 */
1206//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1207
Ronald Cron3768ac12021-01-26 16:58:00 +01001208/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1209 *
1210 * Enable support for PSA crypto client.
1211 *
1212 * \note This option allows to include the code necessary for a PSA
1213 * crypto client when the PSA crypto implementation is not included in
1214 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1215 * code to set and get PSA key attributes.
1216 * The development of PSA drivers partially relying on the library to
1217 * fulfill the hardware gaps is another possible usage of this option.
1218 *
1219 * \warning This interface is experimental and may change or be removed
1220 * without notice.
1221 */
1222//#define MBEDTLS_PSA_CRYPTO_CLIENT
1223
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001224/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1225 *
1226 * Enable support for the experimental PSA crypto driver interface.
1227 *
John Durkop185764f2020-10-12 21:32:12 -07001228 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001229 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001230 * \warning This interface is experimental. We intend to maintain backward
1231 * compatibility with application code that relies on drivers,
1232 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001233 */
1234//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1235
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001236/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1237 *
1238 * Make the PSA Crypto module use an external random generator provided
1239 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1240 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001241 * \note This random generator must deliver random numbers with cryptographic
1242 * quality and high performance. It must supply unpredictable numbers
1243 * with a uniform distribution. The implementation of this function
1244 * is responsible for ensuring that the random generator is seeded
1245 * with sufficient entropy. If you have a hardware TRNG which is slow
1246 * or delivers non-uniform output, declare it as an entropy source
1247 * with mbedtls_entropy_add_source() instead of enabling this option.
1248 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001249 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001250 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1251 * and define a function called mbedtls_psa_external_get_random()
1252 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001253 * ```
1254 * psa_status_t mbedtls_psa_external_get_random(
1255 * mbedtls_psa_external_random_context_t *context,
1256 * uint8_t *output, size_t output_size, size_t *output_length);
1257 * );
1258 * ```
1259 * The \c context value is initialized to 0 before the first call.
1260 * The function must fill the \c output buffer with \p output_size bytes
1261 * of random data and set \c *output_length to \p output_size.
1262 *
1263 * Requires: MBEDTLS_PSA_CRYPTO_C
1264 *
1265 * \warning If you enable this option, code that uses the PSA cryptography
1266 * interface will not use any of the entropy sources set up for
1267 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1268 * enables.
1269 *
1270 * \note This option is experimental and may be removed without notice.
1271 */
1272//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1273
Paul Bakker9dcc3222011-03-08 14:16:06 +00001274/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001275 * \def MBEDTLS_PSA_CRYPTO_SPM
1276 *
1277 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1278 * Partition Manager) integration which separates the code into two parts: a
1279 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1280 * Environment).
1281 *
1282 * Module: library/psa_crypto.c
1283 * Requires: MBEDTLS_PSA_CRYPTO_C
1284 *
1285 */
1286//#define MBEDTLS_PSA_CRYPTO_SPM
1287
1288/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001289 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001291 * Enable support for entropy injection at first boot. This feature is
1292 * required on systems that do not have a built-in entropy source (TRNG).
1293 * This feature is currently not supported on systems that have a built-in
1294 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001296 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297 *
1298 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001299//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001300
1301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001302 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001303 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001304 * Do not use the Chinese Remainder Theorem
1305 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001306 *
1307 * Uncomment this macro to disable the use of CRT in RSA.
1308 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001311
1312/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001314 *
1315 * Enable the checkup functions (*_self_test).
1316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001318
1319/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001320 * \def MBEDTLS_SHA256_SMALLER
1321 *
1322 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1323 * lower performance.
1324 *
Adam Wolf039080f2019-09-10 09:53:08 -05001325 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001326 * performance and size. This version optimizes more aggressively for size at
1327 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1328 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1329 * 30%.
1330 *
1331 * Uncomment to enable the smaller implementation of SHA256.
1332 */
1333//#define MBEDTLS_SHA256_SMALLER
1334
1335/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001336 * \def MBEDTLS_SHA512_SMALLER
1337 *
1338 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1339 * lower performance.
1340 *
1341 * Uncomment to enable the smaller implementation of SHA512.
1342 */
1343//#define MBEDTLS_SHA512_SMALLER
1344
1345/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001347 *
1348 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001349 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001350 * with other servers, only debugging of failures is harder.
1351 *
1352 * The advantage of not sending alert messages, is that no information is given
1353 * about reasons for failures thus preventing adversaries of gaining intel.
1354 *
1355 * Enable sending of all alert messages
1356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001358
1359/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001360 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1361 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001362 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001363 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001364 * in the underlying transport. The CID functionality is described
1365 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001366 *
1367 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001368 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1369 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1370 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001371 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001372 * The maximum lengths of outgoing and incoming CIDs can be configured
1373 * through the options
1374 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1375 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1376 *
1377 * Requires: MBEDTLS_SSL_PROTO_DTLS
1378 *
1379 * Uncomment to enable the Connection ID extension.
1380 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001381#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1382
1383
1384/**
1385 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1386 *
1387 * Defines whether RFC 9146 (default) or the legacy version
1388 * (version draft-ietf-tls-dtls-connection-id-05,
1389 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1390 * is used.
1391 *
1392 * Set the value to 0 for the standard version, and
1393 * 1 for the legacy draft version.
1394 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001395 * \deprecated Support for the legacy version of the DTLS
1396 * Connection ID feature is deprecated. Please
1397 * switch to the standardized version defined
1398 * in RFC 9146 enabled by utilizing
1399 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1400 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1401 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001402 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1403 */
1404#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001405
1406/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001407 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1408 *
1409 * Enable asynchronous external private key operations in SSL. This allows
1410 * you to configure an SSL connection to call an external cryptographic
1411 * module to perform private key operations instead of performing the
1412 * operation inside the library.
1413 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001414 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001415 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001416//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001417
1418/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001419 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1420 *
1421 * Enable serialization of the TLS context structures, through use of the
1422 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1423 *
1424 * This pair of functions allows one side of a connection to serialize the
1425 * context associated with the connection, then free or re-use that context
1426 * while the serialized state is persisted elsewhere, and finally deserialize
1427 * that state to a live context for resuming read/write operations on the
1428 * connection. From a protocol perspective, the state of the connection is
1429 * unaffected, in particular this is entirely transparent to the peer.
1430 *
1431 * Note: this is distinct from TLS session resumption, which is part of the
1432 * protocol and fully visible by the peer. TLS session resumption enables
1433 * establishing new connections associated to a saved session with shorter,
1434 * lighter handshakes, while context serialization is a local optimization in
1435 * handling a single, potentially long-lived connection.
1436 *
1437 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1438 * saved after the handshake to allow for more efficient serialization, so if
1439 * you don't need this feature you'll save RAM by disabling it.
1440 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001441 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1442 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001443 * Comment to disable the context serialization APIs.
1444 */
1445#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1446
1447/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001449 *
1450 * Enable the debug messages in SSL module for all issues.
1451 * Debug messages have been disabled in some places to prevent timing
1452 * attacks due to (unbalanced) debugging function calls.
1453 *
1454 * If you need all error reporting you should enable this during debugging,
1455 * but remove this for production servers that should log as well.
1456 *
1457 * Uncomment this macro to report all debug messages on errors introducing
1458 * a timing side-channel.
1459 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001462
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001464 *
1465 * Enable support for Encrypt-then-MAC, RFC 7366.
1466 *
1467 * This allows peers that both support it to use a more robust protection for
1468 * ciphersuites using CBC, providing deep resistance against timing attacks
1469 * on the padding or underlying cipher.
1470 *
1471 * This only affects CBC ciphersuites, and is useless if none is defined.
1472 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001473 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001474 *
1475 * Comment this macro to disable support for Encrypt-then-MAC
1476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001478
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001480 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001481 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1482 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001483 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001484 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001485 * attacks, but it is recommended to always use it (even if you disable
1486 * renegotiation), since it actually fixes a more fundamental issue in the
1487 * original SSL/TLS design, and has implications beyond Triple Handshake.
1488 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001489 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001490 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001491 * Comment this macro to disable support for Extended Master Secret.
1492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001494
Paul Bakkerd66f0702013-01-31 16:57:45 +01001495/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001496 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1497 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001498 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001499 * giving access to the peer's certificate after completion of the handshake.
1500 *
1501 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1502 * recommended to disable this option for reduced RAM usage.
1503 *
1504 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1505 * defined, but always returns \c NULL.
1506 *
1507 * \note This option has no influence on the protection against the
1508 * triple handshake attack. Even if it is disabled, Mbed TLS will
1509 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001510 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001511 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001512 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1513 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001514 * Comment this macro to disable storing the peer's certificate
1515 * after the handshake.
1516 */
1517#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1518
1519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001521 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001522 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001523 *
1524 * The two main uses of renegotiation are (1) refresh keys on long-lived
1525 * connections and (2) client authentication after the initial handshake.
1526 * If you don't need renegotiation, it's probably better to disable it, since
1527 * it has been associated with security issues in the past and is easy to
1528 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001529 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001530 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001531 *
1532 * \note Even if this option is disabled, both client and server are aware
1533 * of the Renegotiation Indication Extension (RFC 5746) used to
1534 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1535 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1536 * configuration of this extension).
1537 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001540
1541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001543 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001544 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001545 *
1546 * Comment this macro to disable support for the max_fragment_length extension
1547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001548#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001549
1550/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001551 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001552 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001553 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001554 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001555 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1556 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1557 * With MBEDTLS_USE_PSA_CRYPTO:
1558 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1559 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001560 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001561 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1562 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001563 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001564 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001566#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001567
1568/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001569 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001570 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001571 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001572 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001573 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1574 * pre-shared keys are not supported.
1575 * See docs/architecture/tls13-support.md for a description of the TLS
1576 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001577 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001578 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001579 * Requires: MBEDTLS_PSA_CRYPTO_C
1580 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001581 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1582 * directly performed by TLS 1.3 code. As a consequence, you must
1583 * call psa_crypto_init() before the first TLS 1.3 handshake.
1584 *
1585 * \note Cryptographic operations performed indirectly via another module
1586 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1587 * running handshake hash) only use PSA crypto if
1588 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001589 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001590 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001591 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001592//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001593
1594/**
Ronald Cronab65c522021-11-24 10:47:20 +01001595 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1596 *
1597 * Enable TLS 1.3 middlebox compatibility mode.
1598 *
1599 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1600 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1601 * expecting TLS 1.2 traffic.
1602 *
1603 * Turning on the compatibility mode comes at the cost of a few added bytes
1604 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1605 * that don't use it. Therefore, unless transmission bandwidth is critical and
1606 * you know that middlebox compatibility issues won't occur, it is therefore
1607 * recommended to set this option.
1608 *
1609 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001610 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1611 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001612 *
1613 */
1614//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1615
1616/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001617 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1618 *
1619 * Enable TLS 1.3 PSK key exchange mode.
1620 *
1621 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1622 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1623 * effect on the build.
1624 *
1625 */
1626#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1627
1628/**
1629 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1630 *
1631 * Enable TLS 1.3 ephemeral key exchange mode.
1632 *
1633 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1634 * MBEDTLS_PKCS1_V21
1635 *
1636 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1637 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1638 * effect on the build.
1639 *
1640 */
1641#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1642
1643/**
1644 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1645 *
1646 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1647 *
1648 * Requires: MBEDTLS_ECDH_C
1649 *
1650 * Comment to disable support for the PSK ephemeral key exchange mode in
1651 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1652 * have any effect on the build.
1653 *
1654 */
1655#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1656
1657/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 * \def MBEDTLS_SSL_EARLY_DATA
1659 *
1660 * Enable support for RFC 8446 TLS 1.3 early data.
1661 *
1662 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1663 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1664 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1665 *
1666 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1667 * is not enabled, this option does not have any effect on the build.
1668 *
1669 * This feature is experimental, not completed and thus not ready for
1670 * production.
1671 *
1672 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001673//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001674
1675/**
Jerry Yu16f68532022-11-05 10:50:06 +08001676 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1677 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001678 * The default maximum amount of 0-RTT data. See the documentation of
1679 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1680 *
1681 * It must be positive and smaller than UINT32_MAX.
1682 *
1683 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1684 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001685 *
1686 * This feature is experimental, not completed and thus not ready for
1687 * production.
1688 *
1689 */
1690#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1691
1692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001694 *
1695 * Enable support for DTLS (all available versions).
1696 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001697 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001698 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001699 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001700 *
1701 * Comment this macro to disable support for DTLS
1702 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001707 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001708 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001709 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001710 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001713
1714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001716 *
1717 * Enable support for the anti-replay mechanism in DTLS.
1718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * Requires: MBEDTLS_SSL_TLS_C
1720 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001721 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001722 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001723 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001724 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001725 * Comment this to disable anti-replay in DTLS.
1726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001731 *
1732 * Enable support for HelloVerifyRequest on DTLS servers.
1733 *
1734 * This feature is highly recommended to prevent DTLS servers being used as
1735 * amplifiers in DoS attacks against other hosts. It should always be enabled
1736 * unless you know for sure amplification cannot be a problem in the
1737 * environment in which your server operates.
1738 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001739 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001740 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001741 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001742 *
1743 * Comment this to disable support for HelloVerifyRequest.
1744 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001746
1747/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001748 * \def MBEDTLS_SSL_DTLS_SRTP
1749 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001750 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001751 * through the use_srtp extension.
1752 *
1753 * \note This feature provides the minimum functionality required
1754 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1755 * the associated SRTP packet protection key material.
1756 * In particular, the SRTP packet protection itself, as well as the
1757 * demultiplexing of RTP and DTLS packets at the datagram layer
1758 * (see Section 5 of RFC 5764), are not handled by this feature.
1759 * Instead, after successful completion of a handshake negotiating
1760 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001761 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001762 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1763 * (this is implemented in the SSL example programs).
1764 * The resulting key should then be passed to an SRTP stack.
1765 *
1766 * Setting this option enables the runtime API
1767 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1768 * through which the supported DTLS-SRTP protection
1769 * profiles can be configured. You must call this API at
1770 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001771 *
1772 * Requires: MBEDTLS_SSL_PROTO_DTLS
1773 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001774 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001775 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001776//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001777
1778/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001779 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1780 *
1781 * Enable server-side support for clients that reconnect from the same port.
1782 *
1783 * Some clients unexpectedly close the connection and try to reconnect using the
1784 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001785 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001786 * flag enables that support.
1787 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001788 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001789 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001790 * Comment this to disable support for clients reusing the source port.
1791 */
1792#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1793
1794/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001796 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001797 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001798 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001799 * session store remains the responsibility of the application, though).
1800 * Server-side, you also need to provide callbacks for writing and parsing
1801 * tickets, including authenticated encryption and key management. Example
1802 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001803 *
1804 * Comment this macro to disable support for SSL session tickets
1805 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001806#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001807
1808/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001810 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001811 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001812 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001814 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001815 * Comment this macro to disable support for server name indication in SSL
1816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001818
1819/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001820 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1821 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001822 * When this option is enabled, the SSL buffer will be resized automatically
1823 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001824 *
1825 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001826 */
1827//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1828
1829/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001830 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1831 *
1832 * Enable testing of the constant-flow nature of some sensitive functions with
1833 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001834 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001835 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001836 * This setting requires compiling with clang -fsanitize=memory. The test
1837 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001838 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001839 * \warning This macro is only used for extended testing; it is not considered
1840 * part of the library's API, so it may change or disappear at any time.
1841 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001842 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 */
1844//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1845
1846/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001847 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1848 *
1849 * Enable testing of the constant-flow nature of some sensitive functions with
1850 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001852 *
1853 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001854 * testing if the tests suites are run with valgrind's memcheck. This can be
1855 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1856 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001857 *
1858 * \warning This macro is only used for extended testing; it is not considered
1859 * part of the library's API, so it may change or disappear at any time.
1860 *
1861 * Uncomment to enable testing of the constant-flow nature of selected code.
1862 */
1863//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1864
1865/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001866 * \def MBEDTLS_TEST_HOOKS
1867 *
1868 * Enable features for invasive testing such as introspection functions and
1869 * hooks for fault injection. This enables additional unit tests.
1870 *
1871 * Merely enabling this feature should not change the behavior of the product.
1872 * It only adds new code, and new branching points where the default behavior
1873 * is the same as when this feature is disabled.
1874 * However, this feature increases the attack surface: there is an added
1875 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1876 * Therefore this feature must never be enabled in production.
1877 *
1878 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1879 * information.
1880 *
1881 * Uncomment to enable invasive tests.
1882 */
1883//#define MBEDTLS_TEST_HOOKS
1884
1885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001887 *
1888 * Provide your own alternate threading implementation.
1889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001890 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001891 *
1892 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001895
1896/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001897 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001898 *
1899 * Enable the pthread wrapper layer for the threading layer.
1900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001902 *
1903 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001906
1907/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001908 * \def MBEDTLS_USE_PSA_CRYPTO
1909 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001910 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1911 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001912 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001913 * \note Development of this option is currently in progress, and parts of Mbed
1914 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001915 * will still continue to work as usual, so enabling this option should not
1916 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001917 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001918 * \note See docs/use-psa-crypto.md for a complete description of what this
1919 * option currently does, and of parts that are not affected by it so far.
1920 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001921 * \warning If you enable this option, you need to call `psa_crypto_init()`
1922 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001923 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001924 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001925 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001926 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 */
1928//#define MBEDTLS_USE_PSA_CRYPTO
1929
1930/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001931 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1932 *
John Durkop185764f2020-10-12 21:32:12 -07001933 * This setting allows support for cryptographic mechanisms through the PSA
1934 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001935 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001936 * When this option is disabled, the PSA API exposes the cryptographic
1937 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1938 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001939 *
1940 * When this option is enabled, the PSA API exposes the cryptographic
1941 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1942 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1943 * automatically enabled if required (i.e. if no PSA driver provides the
1944 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1945 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001946 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001947 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001948 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001949 *
John Durkop185764f2020-10-12 21:32:12 -07001950 * This feature is still experimental and is not ready for production since
1951 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001952 */
1953//#define MBEDTLS_PSA_CRYPTO_CONFIG
1954
1955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001957 *
1958 * Allow run-time checking of compile-time enabled features. Thus allowing users
1959 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001963 *
1964 * Comment this to disable run-time checking and save ROM space
1965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001967
1968/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001969 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1970 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001971 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001972 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1973 * the set of trusted certificates through a callback instead of a linked
1974 * list.
1975 *
1976 * This is useful for example in environments where a large number of trusted
1977 * certificates is present and storing them in a linked list isn't efficient
1978 * enough, or when the set of trusted certificates changes frequently.
1979 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001980 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001981 * `mbedtls_ssl_conf_ca_cb()` for more information.
1982 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001983 * Requires: MBEDTLS_X509_CRT_PARSE_C
1984 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001985 * Uncomment to enable trusted certificate callbacks.
1986 */
1987//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1988
1989/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001990 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001991 *
Chris Jones2c745862020-12-16 11:41:06 +00001992 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001993 *
Chris Jones2c745862020-12-16 11:41:06 +00001994 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001995 * and other functions/constants only used by these functions, thus reducing
1996 * the code footprint by several KB.
1997 */
Chris Jones2c745862020-12-16 11:41:06 +00001998//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001999
2000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002002 *
2003 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2004 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2005 *
2006 * Comment this macro to disallow using RSASSA-PSS in certificates.
2007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002009/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002010
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002011/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002012 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002013 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002014 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002015 * \{
2016 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002017
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002020 *
2021 * Enable AES-NI support on x86-64.
2022 *
2023 * Module: library/aesni.c
2024 * Caller: library/aes.c
2025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002027 *
2028 * This modules adds support for the AES-NI instructions on x86-64
2029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002031
2032/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002033 * \def MBEDTLS_AESCE_C
2034 *
Jerry Yu751e76b2023-02-16 10:48:15 +08002035 * Enable AES crypto extension support on Arm64.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002036 *
2037 * Module: library/aesce.c
2038 * Caller: library/aes.c
2039 *
2040 * Requires: MBEDTLS_HAVE_ASM, MBEDTLS_AES_C
2041 *
Jerry Yu330e6ae2023-02-21 14:51:38 +08002042 * \warning Runtime detection only works on linux. For non-linux operation
2043 * system, crypto extension MUST be supported by CPU.
2044 *
Jerry Yuc8bcdc82023-02-21 14:49:02 +08002045 * This module adds support for the AES crypto instructions on Arm64
Jerry Yu2fddfd72023-01-10 16:32:03 +08002046 */
2047#define MBEDTLS_AESCE_C
2048
2049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002051 *
2052 * Enable the AES block cipher.
2053 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002054 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002055 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002056 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002057 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002058 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002059 * This module enables the following ciphersuites (if other requisites are
2060 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2062 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2063 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2064 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2065 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2066 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2067 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2068 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2069 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2071 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2072 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2074 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2075 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2076 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2077 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2078 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2079 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2080 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2081 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2082 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2083 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2084 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2085 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2086 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2087 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2088 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2089 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2090 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2091 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2092 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2093 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2094 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2095 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2096 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2097 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2098 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2099 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2100 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2101 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2102 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2103 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2104 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2105 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2106 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2107 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2108 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2109 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2110 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2111 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2112 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2113 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2114 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2115 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2116 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2117 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2118 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002119 *
Paul Bakkercff68422013-09-15 20:43:33 +02002120 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002126 *
2127 * Enable the generic ASN1 parser.
2128 *
2129 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002130 * Caller: library/x509.c
2131 * library/dhm.c
2132 * library/pkcs12.c
2133 * library/pkcs5.c
2134 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002137
2138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002140 *
2141 * Enable the generic ASN1 writer.
2142 *
2143 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002144 * Caller: library/ecdsa.c
2145 * library/pkwrite.c
2146 * library/x509_create.c
2147 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002148 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002151
2152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002154 *
2155 * Enable the Base64 module.
2156 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002157 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002158 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002159 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002160 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002162#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002163
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002166 *
Paul Bakker9a736322012-11-14 12:39:52 +00002167 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002168 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002170 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002171 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002172 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002173 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002174 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002175 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002176 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002177 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002178 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002179 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002180 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002183
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002186 *
2187 * Enable the Camellia block cipher.
2188 *
Paul Bakker38119b12009-01-10 23:31:23 +00002189 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002190 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002191 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002192 * This module enables the following ciphersuites (if other requisites are
2193 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002194 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2195 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2196 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2197 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2198 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2199 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2200 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2201 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2202 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2203 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2204 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2206 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2207 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2208 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2209 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2210 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2211 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2212 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2213 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2214 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2215 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2216 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2217 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2218 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2220 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2223 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2224 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2225 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2226 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2227 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2228 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2229 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2230 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2231 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2232 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2233 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2234 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2235 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002238
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002239/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002240 * \def MBEDTLS_ARIA_C
2241 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002242 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002243 *
2244 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002245 * Caller: library/cipher.c
2246 *
2247 * This module enables the following ciphersuites (if other requisites are
2248 * enabled as well):
2249 *
2250 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2251 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2252 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2255 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2258 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2259 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2260 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2261 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2262 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2265 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2266 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2267 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2268 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2270 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2271 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2272 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2274 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2276 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2277 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2279 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2280 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2281 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2283 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2285 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2286 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2287 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002288 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002289#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002290
2291/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002293 *
2294 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2295 *
2296 * Module: library/ccm.c
2297 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002298 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2299 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002300 *
2301 * This module enables the AES-CCM ciphersuites, if other requisites are
2302 * enabled as well.
2303 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002304#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002305
2306/**
Daniel King34b822c2016-05-15 17:28:08 -03002307 * \def MBEDTLS_CHACHA20_C
2308 *
2309 * Enable the ChaCha20 stream cipher.
2310 *
2311 * Module: library/chacha20.c
2312 */
2313#define MBEDTLS_CHACHA20_C
2314
2315/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002316 * \def MBEDTLS_CHACHAPOLY_C
2317 *
2318 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2319 *
2320 * Module: library/chachapoly.c
2321 *
2322 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2323 */
2324#define MBEDTLS_CHACHAPOLY_C
2325
2326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002328 *
2329 * Enable the generic cipher layer.
2330 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002331 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002332 * Caller: library/ccm.c
2333 * library/cmac.c
2334 * library/gcm.c
2335 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002336 * library/pkcs12.c
2337 * library/pkcs5.c
2338 * library/psa_crypto_aead.c
2339 * library/psa_crypto_mac.c
2340 * library/ssl_ciphersuites.c
2341 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002342 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002343 *
2344 * Uncomment to enable generic cipher wrappers.
2345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002347
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002348/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002349 * \def MBEDTLS_CMAC_C
2350 *
Simon Butcher327398a2016-10-05 14:09:11 +01002351 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2352 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002353 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002354 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2355 * implementation of the CMAC algorithm is provided by an alternate
2356 * implementation, that alternate implementation may opt to not support
2357 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2358 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002359 * Module: library/cmac.c
2360 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002361 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002362 *
2363 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002364#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002365
2366/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002368 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002369 * Enable the CTR_DRBG AES-based random generator.
2370 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002371 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002372 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002373 * \note To achieve a 256-bit security strength with CTR_DRBG,
2374 * you must use AES-256 *and* use sufficient entropy.
2375 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002376 *
2377 * Module: library/ctr_drbg.c
2378 * Caller:
2379 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002381 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002382 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002385
2386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002388 *
2389 * Enable the debug functions.
2390 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002391 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002392 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002393 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002394 * library/ssl_tls12_*.c
2395 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002396 *
2397 * This module provides debugging functions.
2398 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002400
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002401/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002403 *
2404 * Enable the DES block cipher.
2405 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002406 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002407 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002408 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002409 *
Paul Bakkercff68422013-09-15 20:43:33 +02002410 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002411 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002412 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002413 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002416
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002419 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002420 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002421 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002422 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002423 * Caller: library/ssl_tls.c
2424 * library/ssl*_client.c
2425 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002426 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002427 * This module is used by the following key exchanges:
2428 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002429 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002430 * \warning Using DHE constitutes a security risk as it
2431 * is not possible to validate custom DH parameters.
2432 * If possible, it is recommended users should consider
2433 * preferring other methods of key exchange.
2434 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002437#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002438
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002439/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002441 *
2442 * Enable the elliptic curve Diffie-Hellman library.
2443 *
2444 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002445 * Caller: library/psa_crypto.c
2446 * library/ssl_tls.c
2447 * library/ssl*_client.c
2448 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002449 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002450 * This module is used by the following key exchanges:
2451 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002452 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002453 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002456
2457/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002459 *
2460 * Enable the elliptic curve DSA library.
2461 *
2462 * Module: library/ecdsa.c
2463 * Caller:
2464 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002465 * This module is used by the following key exchanges:
2466 * ECDHE-ECDSA
2467 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002468 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2469 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2470 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002472#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002473
2474/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002475 * \def MBEDTLS_ECJPAKE_C
2476 *
2477 * Enable the elliptic curve J-PAKE library.
2478 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002479 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2480 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002481 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002482 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002483 * Module: library/ecjpake.c
2484 * Caller:
2485 *
2486 * This module is used by the following key exchanges:
2487 * ECJPAKE
2488 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002489 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002490 *
2491 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2492 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002493 *
2494 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002495 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002496 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2497 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002498 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002499#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002500
2501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002503 *
2504 * Enable the elliptic curve over GF(p) library.
2505 *
2506 * Module: library/ecp.c
2507 * Caller: library/ecdh.c
2508 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002509 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002510 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002514
2515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002517 *
2518 * Enable the platform-specific entropy code.
2519 *
2520 * Module: library/entropy.c
2521 * Caller:
2522 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002524 *
2525 * This module provides a generic entropy pool
2526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002528
2529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002531 *
2532 * Enable error code to error string conversion.
2533 *
2534 * Module: library/error.c
2535 * Caller:
2536 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002537 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002538 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002540
2541/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002543 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002544 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002545 *
2546 * Module: library/gcm.c
2547 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002548 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2549 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002550 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002551 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2552 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002555
2556/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002557 * \def MBEDTLS_HKDF_C
2558 *
2559 * Enable the HKDF algorithm (RFC 5869).
2560 *
2561 * Module: library/hkdf.c
2562 * Caller:
2563 *
2564 * Requires: MBEDTLS_MD_C
2565 *
2566 * This module adds support for the Hashed Message Authentication Code
2567 * (HMAC)-based key derivation function (HKDF).
2568 */
2569#define MBEDTLS_HKDF_C
2570
2571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002573 *
2574 * Enable the HMAC_DRBG random generator.
2575 *
2576 * Module: library/hmac_drbg.c
2577 * Caller:
2578 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002579 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002580 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002581 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002584
2585/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002586 * \def MBEDTLS_LMS_C
2587 *
2588 * Enable the LMS stateful-hash asymmetric signature algorithm.
2589 *
2590 * Module: library/lms.c
2591 * Caller:
2592 *
Raef Colesab4f8742022-09-01 12:24:31 +01002593 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002594 *
Raef Colesab4f8742022-09-01 12:24:31 +01002595 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002596 */
2597#define MBEDTLS_LMS_C
2598
2599/**
Raef Colesab4f8742022-09-01 12:24:31 +01002600 * \def MBEDTLS_LMS_PRIVATE
2601 *
2602 * Enable LMS private-key operations and signing code. Functions enabled by this
2603 * option are experimental, and should not be used in production.
2604 *
2605 * Requires: MBEDTLS_LMS_C
2606 *
2607 * Uncomment to enable the LMS signature algorithm and private key operations.
2608 */
Raef Coles5127e852022-10-07 10:35:56 +01002609//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002610
2611/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002612 * \def MBEDTLS_NIST_KW_C
2613 *
2614 * Enable the Key Wrapping mode for 128-bit block ciphers,
2615 * as defined in NIST SP 800-38F. Only KW and KWP modes
2616 * are supported. At the moment, only AES is approved by NIST.
2617 *
2618 * Module: library/nist_kw.c
2619 *
2620 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2621 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002622#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002623
2624/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002626 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002627 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002628 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002629 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2630 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2631 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002632 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002633 * Caller: library/constant_time.c
2634 * library/ecdsa.c
2635 * library/ecjpake.c
2636 * library/hkdf.c
2637 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002638 * library/pk.c
2639 * library/pkcs5.c
2640 * library/pkcs12.c
2641 * library/psa_crypto_ecp.c
2642 * library/psa_crypto_rsa.c
2643 * library/rsa.c
2644 * library/ssl_cookie.c
2645 * library/ssl_msg.c
2646 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002647 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002648 * library/x509_crt.c
2649 * library/x509write_crt.c
2650 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002651 *
2652 * Uncomment to enable generic message digest wrappers.
2653 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002655
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002656/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002658 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002659 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002660 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002661 * Module: library/md5.c
2662 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002663 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002664 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002665 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002666 * This module is required for TLS 1.2 depending on the handshake parameters.
2667 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2668 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002669 *
2670 * \warning MD5 is considered a weak message digest and its use constitutes a
2671 * security risk. If possible, we recommend avoiding dependencies on
2672 * it, and considering stronger message digests instead.
2673 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002676
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002677/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002678 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002679 *
2680 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002681 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002682 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002683 *
2684 * Module: library/memory_buffer_alloc.c
2685 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002686 * Requires: MBEDTLS_PLATFORM_C
2687 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002688 *
2689 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002690 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002692
2693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002695 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002696 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2697 *
Simon Butcherd567a232016-03-09 20:19:21 +00002698 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2699 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002700 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002701 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002702 * \note See also our Knowledge Base article about porting to a new
2703 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002704 * 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 +00002705 *
Andres AG788aa4a2016-09-14 14:32:09 +01002706 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002707 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002708 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002709 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002710#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002711
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002712/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002714 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002715 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002716 *
2717 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002718 * Caller: library/asn1write.c
2719 * library/pkcs5.c
2720 * library/pkparse.c
2721 * library/pkwrite.c
2722 * library/rsa.c
2723 * library/x509.c
2724 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002725 * library/x509_crl.c
2726 * library/x509_crt.c
2727 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002728 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002729 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002730 *
2731 * This modules translates between OIDs and internal values.
2732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002734
2735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002737 *
2738 * Enable VIA Padlock support on x86.
2739 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002740 * Module: library/padlock.c
2741 * Caller: library/aes.c
2742 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002744 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002745 * This modules adds support for the VIA PadLock on x86.
2746 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002748
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002749/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002751 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002752 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002753 *
2754 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002755 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002756 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002757 * library/x509_crl.c
2758 * library/x509_crt.c
2759 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002760 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002762 *
Paul Bakkercff68422013-09-15 20:43:33 +02002763 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002766
2767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002770 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002771 *
2772 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002773 * Caller: library/pkwrite.c
2774 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002775 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002776 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002778 *
2779 * This modules adds support for encoding / writing PEM files.
2780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002782
2783/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002785 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002786 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002787 *
2788 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002789 * Caller: library/psa_crypto_rsa.c
2790 * library/ssl_tls.c
2791 * library/ssl*_client.c
2792 * library/ssl*_server.c
2793 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002794 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002795 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002796 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002797 * Uncomment to enable generic public key wrappers.
2798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002800
2801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002803 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002804 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002805 *
2806 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002807 * Caller: library/x509_crt.c
2808 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002811 *
2812 * Uncomment to enable generic public key parse functions.
2813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002815
2816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002818 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002819 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002820 *
2821 * Module: library/pkwrite.c
2822 * Caller: library/x509write.c
2823 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002825 *
2826 * Uncomment to enable generic public key write functions.
2827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002829
2830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002833 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002834 *
2835 * Module: library/pkcs5.c
2836 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002837 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2838 *
2839 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2840 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002841 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002842 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002843 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002844 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2845 * this module in builds where MBEDTLS_MD_C is disabled.
2846 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002847 * This module adds support for the PKCS#5 functions.
2848 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002850
2851/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002852 * \def MBEDTLS_PKCS7_C
2853 *
Dave Rodgmandbcbf442022-12-05 11:15:10 +00002854 * This feature is a work in progress and not ready for production. Testing and
2855 * validation is incomplete, and handling of malformed inputs may not be robust.
2856 * The API may change.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002857 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002858 * Enable PKCS7 core for using PKCS7 formatted signatures.
2859 * RFC Link - https://tools.ietf.org/html/rfc2315
2860 *
2861 * Module: library/pkcs7.c
2862 *
2863 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002864 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2865 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002866 *
2867 * This module is required for the PKCS7 parsing modules.
2868 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002869//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002870
2871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002873 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002874 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002875 * Adds algorithms for parsing PKCS#8 encrypted private keys
2876 *
2877 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002878 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002879 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002880 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2881 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2882 *
2883 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2884 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002885 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002886 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002887 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002888 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2889 * this module in builds where MBEDTLS_MD_C is disabled.
2890 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002891 * This module enables PKCS#12 functions.
2892 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002894
2895/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002897 *
2898 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002899 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002900 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2902 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002903 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002904 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002905 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002906 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002907 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002908 * Module: library/platform.c
2909 * Caller: Most other .c files
2910 *
2911 * This module enables abstraction of common (libc) functions.
2912 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002913#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002914
2915/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002916 * \def MBEDTLS_POLY1305_C
2917 *
2918 * Enable the Poly1305 MAC algorithm.
2919 *
2920 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002921 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002922 */
2923#define MBEDTLS_POLY1305_C
2924
2925/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002926 * \def MBEDTLS_PSA_CRYPTO_C
2927 *
2928 * Enable the Platform Security Architecture cryptography API.
2929 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002930 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002931 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002932 * Requires: MBEDTLS_CIPHER_C,
2933 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002934 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002935 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002936 *
2937 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002938#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002939
2940/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002941 * \def MBEDTLS_PSA_CRYPTO_SE_C
2942 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002943 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002944 * cryptography API.
2945 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002946 * \deprecated This feature is deprecated. Please switch to the driver
2947 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002948 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002949 * Module: library/psa_crypto_se.c
2950 *
2951 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2952 *
2953 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002954//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002955
2956/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002957 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2958 *
2959 * Enable the Platform Security Architecture persistent key storage.
2960 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002961 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002962 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002963 * Requires: MBEDTLS_PSA_CRYPTO_C,
2964 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2965 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002966 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002967#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002968
2969/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002970 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002971 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002972 * Enable the emulation of the Platform Security Architecture
2973 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002974 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002975 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002976 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002977 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002978 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002979#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002980
2981/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002983 *
2984 * Enable the RIPEMD-160 hash algorithm.
2985 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002986 * Module: library/ripemd160.c
2987 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002988 *
2989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002991
2992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002993 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002994 *
2995 * Enable the RSA public-key cryptosystem.
2996 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002998 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002999 * Caller: library/pk.c
3000 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003001 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003002 * library/ssl*_client.c
3003 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003004 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003005 * This module is used by the following key exchanges:
3006 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003007 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003011
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003014 *
3015 * Enable the SHA1 cryptographic hash algorithm.
3016 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003017 * Module: library/sha1.c
3018 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003019 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003020 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003021 * This module is required for TLS 1.2 depending on the handshake parameters,
3022 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003023 *
3024 * \warning SHA-1 is considered a weak message digest and its use constitutes
3025 * a security risk. If possible, we recommend avoiding dependencies
3026 * on it, and considering stronger message digests instead.
3027 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003029#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003030
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003032 * \def MBEDTLS_SHA224_C
3033 *
3034 * Enable the SHA-224 cryptographic hash algorithm.
3035 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003036 * Module: library/sha256.c
3037 * Caller: library/md.c
3038 * library/ssl_cookie.c
3039 *
3040 * This module adds support for SHA-224.
3041 */
3042#define MBEDTLS_SHA224_C
3043
3044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003045 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003046 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003047 * Enable the SHA-256 cryptographic hash algorithm.
3048 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003049 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003050 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003051 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003052 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003053 * library/ssl*_client.c
3054 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003055 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003056 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003057 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003062 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3063 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003064 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3065 * with the ARMv8 cryptographic extensions if they are available at runtime.
3066 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003067 *
3068 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3069 * for a non-Aarch64 build it will be silently ignored.
3070 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003071 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3072 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3073 *
3074 * Requires: MBEDTLS_SHA256_C.
3075 *
3076 * Module: library/sha256.c
3077 *
3078 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3079 * and use them if available.
3080 */
3081//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3082
3083/**
3084 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3085 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003086 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3087 * with the ARMv8 cryptographic extensions, which must be available at runtime
3088 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003089 *
3090 * \note This allows builds with a smaller code size than with
3091 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3092 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003093 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3094 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3095 *
3096 * Requires: MBEDTLS_SHA256_C.
3097 *
3098 * Module: library/sha256.c
3099 *
3100 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3101 * unconditionally.
3102 */
3103//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3104
3105/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003106 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003107 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003108 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003109 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003110 * Module: library/sha512.c
3111 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003112 * library/psa_crypto_hash.c
3113 * library/ssl_tls.c
3114 * library/ssl*_client.c
3115 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003116 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003117 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003118 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003119#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003120
3121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003123 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003124 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003125 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003126 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003127 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003128 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003129 * library/ssl_tls.c
3130 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003131 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003132 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003135
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003136/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003137 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3138 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003139 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3140 * with the ARMv8 cryptographic extensions if they are available at runtime.
3141 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003142 *
3143 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3144 * for a non-Aarch64 build it will be silently ignored.
3145 *
3146 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003147 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003148 *
3149 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3150 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3151 *
3152 * Requires: MBEDTLS_SHA512_C.
3153 *
3154 * Module: library/sha512.c
3155 *
3156 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3157 * and use them if available.
3158 */
3159//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3160
3161/**
3162 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3163 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003164 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3165 * with the ARMv8 cryptographic extensions, which must be available at runtime
3166 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003167 *
3168 * \note This allows builds with a smaller code size than with
3169 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3170 *
3171 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003172 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003173 *
3174 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3175 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3176 *
3177 * Requires: MBEDTLS_SHA512_C.
3178 *
3179 * Module: library/sha512.c
3180 *
3181 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3182 * unconditionally.
3183 */
3184//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3185
3186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003188 *
3189 * Enable simple SSL cache implementation.
3190 *
3191 * Module: library/ssl_cache.c
3192 * Caller:
3193 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003197
3198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003200 *
3201 * Enable basic implementation of DTLS cookies for hello verification.
3202 *
3203 * Module: library/ssl_cookie.c
3204 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003207
3208/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003209 * \def MBEDTLS_SSL_TICKET_C
3210 *
3211 * Enable an implementation of TLS server-side callbacks for session tickets.
3212 *
3213 * Module: library/ssl_ticket.c
3214 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003215 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003216 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3217 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003218 */
3219#define MBEDTLS_SSL_TICKET_C
3220
3221/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003223 *
3224 * Enable the SSL/TLS client code.
3225 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003226 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003227 * Caller:
3228 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003230 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003231 * This module is required for SSL/TLS client support.
3232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003234
Paul Bakker9a736322012-11-14 12:39:52 +00003235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003237 *
3238 * Enable the SSL/TLS server code.
3239 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003240 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003241 * Caller:
3242 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003244 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003245 * This module is required for SSL/TLS server support.
3246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003248
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003251 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003252 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003253 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003255 * Caller: library/ssl*_client.c
3256 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3259 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003260 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003261 * This module is required for SSL/TLS.
3262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263#define MBEDTLS_SSL_TLS_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_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003267 *
3268 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003269 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003270 * contexts are not shared between threads. If you do intend to use contexts
3271 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003272 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003273 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003274 *
3275 * Module: library/threading.c
3276 *
3277 * This allows different threading implementations (self-implemented or
3278 * provided).
3279 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * You will have to enable either MBEDTLS_THREADING_ALT or
3281 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003282 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003283 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003286
3287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003289 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003290 * Enable the semi-portable timing interface.
3291 *
Simon Butcherd567a232016-03-09 20:19:21 +00003292 * \note The provided implementation only works on POSIX/Unix (including Linux,
3293 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003294 * module and provide your own implementations of the callbacks needed by
3295 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3296 * your own implementation of the whole module by setting
3297 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003298 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003299 * \note The timing module will include time.h on suitable platforms
3300 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3301 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3302 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003303 * \note See also our Knowledge Base article about porting to a new
3304 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003305 * 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 +00003306 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003307 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003310
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003311/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003312 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003313 *
3314 * Enable run-time version information.
3315 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003316 * Module: library/version.c
3317 *
3318 * This module provides run-time version information.
3319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003321
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003324 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003325 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003326 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003327 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003328 * Caller: library/x509_crl.c
3329 * library/x509_crt.c
3330 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003331 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003332 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003333 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3334 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003335 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3336 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003337 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003338 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003341
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003343 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003344 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003345 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003346 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003347 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003348 * Caller: library/ssl_tls.c
3349 * library/ssl*_client.c
3350 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003351 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003353 *
3354 * This module is required for X.509 certificate parsing.
3355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357
3358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003360 *
3361 * Enable X.509 CRL parsing.
3362 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003363 * Module: library/x509_crl.c
3364 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003365 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003367 *
3368 * This module is required for X.509 CRL parsing.
3369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371
3372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003374 *
3375 * Enable X.509 Certificate Signing Request (CSR) parsing.
3376 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003377 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003378 * Caller: library/x509_crt_write.c
3379 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003381 *
3382 * This module is used for reading X.509 certificate request.
3383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003385
3386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003389 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003390 *
3391 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003392 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003393 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003394 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3395 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003396 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3397 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003398 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003399 * This module is the basis for creating X.509 certificates and CSRs.
3400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402
3403/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003405 *
3406 * Enable creating X.509 certificates.
3407 *
3408 * Module: library/x509_crt_write.c
3409 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 *
3412 * This module is required for X.509 certificate creation.
3413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003415
3416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003418 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003419 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420 *
3421 * Module: library/x509_csr_write.c
3422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003424 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003425 * This module is required for X.509 certificate request writing.
3426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003428
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003429/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003430
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003431/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003432 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003433 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003434 * This section contains Mbed TLS build settings that are not associated
3435 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003436 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003437 * \{
3438 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003439
Gilles Peskinea02c1242022-03-16 17:03:19 +01003440/**
3441 * \def MBEDTLS_CONFIG_FILE
3442 *
3443 * If defined, this is a header which will be included instead of
3444 * `"mbedtls/mbedtls_config.h"`.
3445 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003446 * Unlike other configuration options, this one must be defined on the
3447 * compiler command line: a definition in `mbedtls_config.h` would have
3448 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003449 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003450 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003451 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003452 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003453 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003454 * The value of this symbol is typically a path in double quotes, either
3455 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003456 */
3457//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3458
3459/**
3460 * \def MBEDTLS_USER_CONFIG_FILE
3461 *
3462 * If defined, this is a header which will be included after
3463 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003464 * This allows you to modify the default configuration, including the ability
3465 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003466 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003467 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003468 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003469 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003470 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003471 * The value of this symbol is typically a path in double quotes, either
3472 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003473 */
3474//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3475
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003476/**
3477 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3478 *
3479 * If defined, this is a header which will be included instead of
3480 * `"psa/crypto_config.h"`.
3481 * This header file specifies which cryptographic mechanisms are available
3482 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3483 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3484 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003485 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003486 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003487 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003488 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003489 * The value of this symbol is typically a path in double quotes, either
3490 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003491 */
3492//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3493
3494/**
3495 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3496 *
3497 * If defined, this is a header which will be included after
3498 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003499 * This allows you to modify the default configuration, including the ability
3500 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003501 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003502 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003503 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003504 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003505 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003506 * The value of this symbol is typically a path in double quotes, either
3507 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003508 */
3509//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3510
Gilles Peskineb1176f22023-02-22 22:07:28 +01003511/**
3512 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3513 *
3514 * If defined, this is a header which will be included instead of
3515 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3516 * as the one in Mbed TLS, but with definitions adapted to the platform on
3517 * which the library code will run.
3518 *
3519 * \note The required content of this header can vary from one version of
3520 * Mbed TLS to the next. Integrators who provide an alternative file
3521 * should review the changes in the original file whenever they
3522 * upgrade Mbed TLS.
3523 *
3524 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3525 * non-standard feature of the C language, so this feature is only available
3526 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3527 *
3528 * The value of this symbol is typically a path in double quotes, either
3529 * absolute or relative to a directory on the include search path.
3530 */
3531//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3532
3533/**
3534 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3535 *
3536 * If defined, this is a header which will be included instead of
3537 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3538 * as the one in Mbed TLS, but with definitions adapted to the environment
3539 * in which the library code will run. The typical use for this feature
3540 * is to provide alternative type definitions on the client side in
3541 * client-server integrations of PSA crypto, where operation structures
3542 * contain handles instead of cryptographic data.
3543 *
3544 * \note The required content of this header can vary from one version of
3545 * Mbed TLS to the next. Integrators who provide an alternative file
3546 * should review the changes in the original file whenever they
3547 * upgrade Mbed TLS.
3548 *
3549 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3550 * non-standard feature of the C language, so this feature is only available
3551 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3552 *
3553 * The value of this symbol is typically a path in double quotes, either
3554 * absolute or relative to a directory on the include search path.
3555 */
3556//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3557
Gilles Peskineba4162a2022-04-11 17:04:38 +02003558/** \} name SECTION: General configuration options */
3559
3560/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003561 * \name SECTION: Module configuration options
3562 *
3563 * This section allows for the setting of module specific sizes and
3564 * configuration options. The default values are already present in the
3565 * relevant header files and should suffice for the regular use cases.
3566 *
3567 * Our advice is to enable options and change their values here
3568 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003569 * \{
3570 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003571/* The Doxygen documentation here is used when a user comments out a
3572 * setting and runs doxygen themselves. On the other hand, when we typeset
3573 * the full documentation including disabled settings, the documentation
3574 * in specific modules' header files is used if present. When editing this
3575 * file, make sure that each option is documented in exactly one place,
3576 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3577 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003578
Paul Bakker088c5c52014-04-25 11:11:10 +02003579/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003580//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003582
Paul Bakker088c5c52014-04-25 11:11:10 +02003583/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3585//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3586//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3587//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3588//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003589
Paul Bakker088c5c52014-04-25 11:11:10 +02003590/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3592//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3593//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3594//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003595
Paul Bakker088c5c52014-04-25 11:11:10 +02003596/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003597//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003599
Paul Bakker088c5c52014-04-25 11:11:10 +02003600/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3602//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003603//#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 +01003604
Paul Bakker088c5c52014-04-25 11:11:10 +02003605/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003607
Paul Bakker088c5c52014-04-25 11:11:10 +02003608/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003609//#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. */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003610//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003612//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003613//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003614//#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 +02003615//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3616//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003617/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003619//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3620//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003621//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3622//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3623//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003624
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3626/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003627//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3629//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003630//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003631//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3632//#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 +02003633//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3634//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003635/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003637//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003638//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3639//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003640
Gilles Peskine3f106f72021-09-23 17:42:39 +02003641/** \def MBEDTLS_CHECK_RETURN
3642 *
3643 * This macro is used at the beginning of the declaration of a function
3644 * to indicate that its return value should be checked. It should
3645 * instruct the compiler to emit a warning or an error if the function
3646 * is called without checking its return value.
3647 *
3648 * There is a default implementation for popular compilers in platform_util.h.
3649 * You can override the default implementation by defining your own here.
3650 *
3651 * If the implementation here is empty, this will effectively disable the
3652 * checking of functions' return values.
3653 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003654//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003655
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003656/** \def MBEDTLS_IGNORE_RETURN
3657 *
3658 * This macro requires one argument, which should be a C function call.
3659 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3660 * warning is suppressed.
3661 */
3662//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3663
Gilles Peskineed038902020-11-13 21:33:21 +01003664/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003665/**
Gilles Peskineed038902020-11-13 21:33:21 +01003666 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3667 * PSA crypto subsystem.
3668 *
3669 * If this option is unset:
3670 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003671 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003672 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3673 * on unspecified heuristics.
3674 */
3675//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3676
Steven Cooreman863470a2021-02-15 14:03:19 +01003677/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003678 * Restrict the PSA library to supporting a maximum amount of simultaneously
3679 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3680 * volatile key, or a persistent key which is loaded temporarily by the
3681 * library as part of a crypto operation in flight.
3682 *
3683 * If this option is unset, the library will fall back to a default value of
3684 * 32 keys.
3685 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003686//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003687
Paul Bakker088c5c52014-04-25 11:11:10 +02003688/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003689//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3690//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003691
Paul Bakker088c5c52014-04-25 11:11:10 +02003692/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003693
Angus Grattond8213d02016-05-25 20:56:48 +10003694/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3695 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003696 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003697 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003698 * This determines the size of the incoming TLS I/O buffer in such a way
3699 * that it is capable of holding the specified amount of plaintext data,
3700 * regardless of the protection mechanism used.
3701 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003702 * \note When using a value less than the default of 16KB on the client, it is
3703 * recommended to use the Maximum Fragment Length (MFL) extension to
3704 * inform the server about this limitation. On the server, there
3705 * is no supported, standardized way of informing the client about
3706 * restriction on the maximum size of incoming messages, and unless
3707 * the limitation has been communicated by other means, it is recommended
3708 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3709 * while keeping the default value of 16KB for the incoming buffer.
3710 *
David Horstmann95d516f2021-05-04 18:36:56 +01003711 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003712 */
3713//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3714
Gilles Peskined3d02902020-03-04 21:35:27 +01003715/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3716 *
3717 * The maximum length of CIDs used for incoming DTLS messages.
3718 *
3719 */
3720//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3721
3722/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3723 *
3724 * The maximum length of CIDs used for outgoing DTLS messages.
3725 *
3726 */
3727//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3728
TRodziewicze8dd7092021-05-12 14:19:11 +02003729/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003730 *
3731 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003732 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003733 *
3734 * The padding will always be chosen so that the length of the
3735 * padded plaintext is a multiple of the value of this option.
3736 *
3737 * Note: A value of \c 1 means that no padding will be used
3738 * for outgoing records.
3739 *
3740 * Note: On systems lacking division instructions,
3741 * a power of two should be preferred.
3742 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003743//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003744
Angus Grattond8213d02016-05-25 20:56:48 +10003745/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3746 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003747 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003748 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003749 * This determines the size of the outgoing TLS I/O buffer in such a way
3750 * that it is capable of holding the specified amount of plaintext data,
3751 * regardless of the protection mechanism used.
3752 *
Angus Grattond8213d02016-05-25 20:56:48 +10003753 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3754 * the default inward 16384 byte buffer to conform to the TLS specification.
3755 *
3756 * The minimum required outward buffer size is determined by the handshake
3757 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3758 * The specific size requirement depends on the configured ciphers and any
3759 * certificate data which is sent during the handshake.
3760 *
David Horstmann95d516f2021-05-04 18:36:56 +01003761 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003762 */
3763//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3764
Hanno Beckere0b150f2018-08-21 15:51:03 +01003765/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3766 *
3767 * Maximum number of heap-allocated bytes for the purpose of
3768 * DTLS handshake message reassembly and future message buffering.
3769 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003770 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003771 * to account for a reassembled handshake message of maximum size,
3772 * together with its reassembly bitmap.
3773 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003774 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003775 * should be sufficient for all practical situations as it allows
3776 * to reassembly a large handshake message (such as a certificate)
3777 * while buffering multiple smaller handshake messages.
3778 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003779 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003780//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003781
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003782//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3783//#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 +02003784
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003785/**
3786 * Complete list of ciphersuites to use, in order of preference.
3787 *
3788 * \warning No dependency checking is done on that field! This option can only
3789 * be used to restrict the set of available ciphersuites. It is your
3790 * responsibility to make sure the needed modules are active.
3791 *
3792 * Use this to save a few hundred bytes of ROM (default ordering of all
3793 * available ciphersuites) and a few to a few hundred bytes of RAM.
3794 *
3795 * The value below is only an example, not the default.
3796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003797//#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 +02003798
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003799/**
3800 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3801 *
3802 * Maximum time difference in milliseconds tolerated between the age of a
3803 * ticket from the server and client point of view.
3804 * From the client point of view, the age of a ticket is the time difference
3805 * between the time when the client proposes to the server to use the ticket
3806 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3807 * the time the client received the ticket from the server.
3808 * From the server point of view, the age of a ticket is the time difference
3809 * between the time when the server receives a proposition from the client
3810 * to use the ticket and the time when the ticket was created by the server.
3811 * The server age is expected to be always greater than the client one and
3812 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3813 * maximum difference tolerated for the server to accept the ticket.
3814 * This is not used in TLS 1.2.
3815 *
3816 */
3817#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3818
3819/**
3820 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3821 *
3822 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3823 *
3824 * This must be less than 256.
3825 */
3826#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3827
3828/**
3829 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3830 *
3831 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3832 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3833 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3834 *
3835 */
3836#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3837
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003838/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003839//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003840//#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 +01003841
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003842/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003843 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003844 * mbedtls_platform_zeroize(). This replaces the default implementation in
3845 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003846 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003847 * mbedtls_platform_zeroize() is a widely used function across the library to
3848 * zero a block of memory. The implementation is expected to be secure in the
3849 * sense that it has been written to prevent the compiler from removing calls
3850 * to mbedtls_platform_zeroize() as part of redundant code elimination
3851 * optimizations. However, it is difficult to guarantee that calls to
3852 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3853 * versions of the C language standards do not provide a secure implementation
3854 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3855 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003856 * example by using directives specific to their compiler, features from newer
3857 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003858 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003859 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003860//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003861
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003862/**
3863 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003864 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003865 * platform_util.c.
3866 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003867 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003868 * library will try to use safer implementations of this function, such as
3869 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003870 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003871 * using the standard gmtime(). In this case, calls from the library to
3872 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003873 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003874 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003875 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3876 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3877 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003878 */
Hanno Becker6a739782018-09-05 15:06:19 +01003879//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003880
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003881/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003882 * Enable the verified implementations of ECDH primitives from Project Everest
3883 * (currently only Curve25519). This feature changes the layout of ECDH
3884 * contexts and therefore is a compatibility break for applications that access
3885 * fields of a mbedtls_ecdh_context structure directly. See also
3886 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003887 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003888//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003889
Gilles Peskine611179c2022-04-13 23:04:48 +02003890/** \} name SECTION: Module configuration options */