blob: 84b653174d12a2f95201aafea26d34c1253d46c7 [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:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000058 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010059 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010060 * MBEDTLS_PADLOCK_C
61 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020062 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000065
Paul Bakkerf3b86c12011-01-27 15:24:17 +000066/**
Gilles Peskineed942f82017-06-08 15:19:20 +020067 * \def MBEDTLS_NO_UDBL_DIVISION
68 *
69 * The platform lacks support for double-width integer division (64-bit
70 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
71 *
72 * Used in:
73 * include/mbedtls/bignum.h
74 * library/bignum.c
75 *
76 * The bignum code uses double-width division to speed up some operations.
77 * Double-width division is often implemented in software that needs to
78 * be linked with the program. The presence of a double-width integer
79 * type is usually detected automatically through preprocessor macros,
80 * but the automatic detection cannot know whether the code needs to
81 * and can be linked with an implementation of division for that type.
82 * By default division is assumed to be usable if the type is present.
83 * Uncomment this option to prevent the use of double-width division.
84 *
85 * Note that division for the native integer type is always required.
86 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010087 * platform, but it need not support multiplication or division. In some
88 * cases it is also desirable to disable some double-width operations. For
89 * example, if double-width division is implemented in software, disabling
90 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020091 */
92//#define MBEDTLS_NO_UDBL_DIVISION
93
94/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020095 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
96 *
97 * The platform lacks support for 32x32 -> 64-bit multiplication.
98 *
99 * Used in:
100 * library/poly1305.c
101 *
102 * Some parts of the library may use multiplication of two unsigned 32-bit
103 * operands with a 64-bit result in order to speed up computations. On some
104 * platforms, this is not available in hardware and has to be implemented in
105 * software, usually in a library provided by the toolchain.
106 *
107 * Sometimes it is not desirable to have to link to that library. This option
108 * removes the dependency of that library on platforms that lack a hardware
109 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
110 *
111 * Note that depending on the compiler, this may decrease performance compared
112 * to using the library function provided by the toolchain.
113 */
114//#define MBEDTLS_NO_64BIT_MULTIPLICATION
115
116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000118 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000119 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124
125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200128 * System has time.h and time().
129 * The time does not need to be correct, only time differences are used,
130 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100132 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
133 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
134 * MBEDTLS_PLATFORM_STD_TIME.
135 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400136 * Comment if your system does not support time functions.
137 *
138 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
139 * interface - timing.c will include time.h on suitable platforms
140 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
141 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100144
145/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * \def MBEDTLS_HAVE_TIME_DATE
147 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100148 * System has time.h, time(), and an implementation for
149 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100150 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 * the date should be correct). This is used to verify the validity period of
152 * X.509 certificates.
153 *
154 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100155 *
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100157 * behaves similarly to the gmtime_r() function from the C standard. Refer to
158 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100159 *
160 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100161 * mbedtls_platform_gmtime_r() at compile-time by using the macro
162 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200163 */
164#define MBEDTLS_HAVE_TIME_DATE
165
166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 *
169 * Enable the memory allocation layer.
170 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100172 * This allows different allocators (self-implemented or provided) to be
173 * provided to the platform abstraction layer.
174 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
177 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * free() function pointer at runtime.
179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200181 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000182 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100183 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185 *
186 * Enable this layer to allow use of alternative memory allocators.
187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100189
190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200192 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200193 * Do not assign standard functions in the platform layer (e.g. calloc() to
194 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200195 *
196 * This makes sure there are no linking errors on platforms that do not support
197 * these functions. You will HAVE to provide alternatives, either at runtime
198 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
200 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200203 *
204 * Uncomment to prevent default assignment of standard functions in the
205 * platform layer.
206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200208
209/**
Janos Follathc351d182016-03-21 08:43:59 +0000210 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100211 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100212 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
213 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
216 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100217 * alternative printf function pointer.
218 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100220 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200221 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
222 * it will be enabled automatically by check_config.h
223 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200224 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000226 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100227 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
228 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 * Uncomment a macro to enable alternate implementation of specific base
230 * platform function
231 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200232//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100234//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200235//#define MBEDTLS_PLATFORM_FPRINTF_ALT
236//#define MBEDTLS_PLATFORM_PRINTF_ALT
237//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200238//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100239//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100240//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800241//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100242
243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000246 * Mark deprecated functions and features so that they generate a warning if
247 * used. Functionality deprecated in one version will usually be removed in the
248 * next version. You can enable this to help you prepare the transition to a
249 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 *
251 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257
258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000261 * Remove deprecated functions and features so that they generate an error if
262 * used. Functionality deprecated in one version will usually be removed in the
263 * next version. You can enable this to help you prepare the transition to a
264 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100265 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000266 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100269
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100270/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000271
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000272/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000273 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000274 *
275 * This section sets support for features that are or are not needed
276 * within the modules that are enabled.
277 * \{
278 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000279
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100282 *
TRodziewiczd8540832021-06-10 15:16:50 +0200283 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200284 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100287 *
288 * You will need to provide a header "timing_alt.h" and an implementation at
289 * compile time.
290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100292
293/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100294 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200295 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100296 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100297 * alternate core implementation of a symmetric crypto, an arithmetic or hash
298 * module (e.g. platform specific assembly optimized implementations). Keep
299 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200300 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200301 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200303 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000305 * provide the "struct mbedtls_aes_context" definition and omit the base
306 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200307 * "aes.h" to include the new function definitions.
308 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200309 * Uncomment a macro to enable alternate implementation of the corresponding
310 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100311 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200312 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100313 * use constitutes a security risk. If possible, we recommend
314 * avoiding dependencies on them, and considering stronger message
315 * digests and ciphers instead.
316 *
Paul Bakker90995b52013-06-24 19:20:35 +0200317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000319//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200321//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300322//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200323//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200324//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000326//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000327//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100328//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300329//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300331//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000333//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334//#define MBEDTLS_SHA1_ALT
335//#define MBEDTLS_SHA256_ALT
336//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000337
Janos Follathb0697532016-08-18 12:38:46 +0100338/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800339 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100340 * implemented with two .c files:
341 * - ecp.c
342 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000343 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
344 * macros as described above. The only difference is that you have to make sure
345 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100346 */
347//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200348
349/**
TRodziewicz75628d52021-06-18 12:56:27 +0200350 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200351 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100352 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
353 * alternate core implementation of symmetric crypto or hash function. Keep in
354 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355 *
356 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
360 * no longer provide the mbedtls_sha1_process() function, but it will still provide
361 * the other function (using your mbedtls_sha1_process() function) and the definition
362 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * with this definition.
364 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200365 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100366 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
367 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * constitutes a security risk. If possible, we recommend avoiding
374 * dependencies on them, and considering stronger message digests
375 * and ciphers instead.
376 *
Janos Follath1231d212019-01-07 15:01:32 +0000377 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
378 * enabled, then the deterministic ECDH signature functions pass the
379 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
380 * alternative implementations should use the RNG only for generating
381 * the ephemeral key and nothing else. If this is not possible, then
382 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200383 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000384 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_MD5_PROCESS_ALT
387//#define MBEDTLS_RIPEMD160_PROCESS_ALT
388//#define MBEDTLS_SHA1_PROCESS_ALT
389//#define MBEDTLS_SHA256_PROCESS_ALT
390//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200391//#define MBEDTLS_DES_SETKEY_ALT
392//#define MBEDTLS_DES_CRYPT_ECB_ALT
393//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200394//#define MBEDTLS_AES_SETKEY_ENC_ALT
395//#define MBEDTLS_AES_SETKEY_DEC_ALT
396//#define MBEDTLS_AES_ENCRYPT_ALT
397//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300398//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300399//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300400//#define MBEDTLS_ECDSA_VERIFY_ALT
401//#define MBEDTLS_ECDSA_SIGN_ALT
402//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200403
404/**
Janos Follathc44ab972016-11-18 16:38:23 +0000405 * \def MBEDTLS_ECP_INTERNAL_ALT
406 *
407 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100408 *
409 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100410 * alternative core implementation of elliptic curve arithmetic. Keep in mind
411 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100412 *
413 * This partially replaces one function. The header file from mbed TLS is still
414 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
415 * is still present and it is used for group structures not supported by the
416 * alternative.
417 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100418 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100419 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100420 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
421 * able to fallback to curves not supported by the alternative implementation.
422 *
Janos Follathc44ab972016-11-18 16:38:23 +0000423 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
424 * and implementing the following functions:
425 * unsigned char mbedtls_internal_ecp_grp_capable(
426 * const mbedtls_ecp_group *grp )
427 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500428 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000429 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
430 * replacement functions implement arithmetic for the given group and 0
431 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500432 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000433 * called before and after each point operation and provide an opportunity to
434 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100435 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100436 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
437 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
438 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
439 * for the operation is supported by your implementation (i.e. your
440 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
441 * group is not supported by your implementation, then the original mbed TLS
442 * implementation of ecp_double_jac() is used instead, unless this fallback
443 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
444 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
445 *
446 * The function prototypes and the definition of mbedtls_ecp_group and
447 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
448 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
449 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100450 *
451 * Uncomment a macro to enable alternate implementation of the corresponding
452 * function.
453 */
454/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000455//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100456/* Turn off software fallback for curves not supported in hardware */
457//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100458/* Support for Weierstrass curves with Jacobi representation */
459//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
460//#define MBEDTLS_ECP_ADD_MIXED_ALT
461//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
462//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
463//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
464/* Support for curves with Montgomery arithmetic */
465//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
466//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
467//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
468
469/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200470 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200471 *
472 * Uncomment this macro to let mbed TLS use your own implementation of a
473 * hardware entropy collector.
474 *
475 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000476 * prototype as declared in library/entropy_poll.h, and accept NULL as first
477 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200478 *
479 * Uncomment to use your own hardware entropy collector.
480 */
481//#define MBEDTLS_ENTROPY_HARDWARE_ALT
482
483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000485 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100486 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000487 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100488 * Uncomment this macro to use precomputed AES tables stored in ROM.
489 * Comment this macro to generate AES tables in RAM at runtime.
490 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100491 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
492 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100493 * initialization time before the first AES operation can be performed.
494 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
495 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
496 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100497 *
498 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
499 *
Paul Bakker15566e42011-04-24 21:19:15 +0000500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200501//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000502
503/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100504 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200505 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100506 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200507 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100508 * Uncommenting this macro omits 75% of the AES tables from
509 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
510 * by computing their values on the fly during operations
511 * (the tables are entry-wise rotations of one another).
512 *
513 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100514 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100515 * runtime. Specifically, one has to compare 4 accesses within
516 * different tables to 4 accesses with additional arithmetic
517 * operations within the same table. The performance gain/loss
518 * depends on the system and memory details.
519 *
520 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
521 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200522 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100523//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200524
525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200527 *
528 * Use less ROM for the Camellia implementation (saves about 768 bytes).
529 *
530 * Uncomment this macro to use less memory for Camellia.
531 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200533
534/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200535 * \def MBEDTLS_CHECK_RETURN_WARNING
536 *
537 * If this macro is defined, emit a compile-time warning if application code
538 * calls a function without checking its return value, but the return value
539 * should generally be checked in portable applications.
540 *
541 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
542 * implemented. Otherwise this option has no effect.
543 *
544 * Uncomment to get warnings on using fallible functions without checking
545 * their return value.
546 *
547 * \note This feature is a work in progress.
548 * Warnings will be added to more functions in the future.
549 *
550 * \note A few functions are considered critical, and ignoring the return
551 * value of these functions will trigger a warning even if this
552 * macro is not defined. To completely disable return value check
553 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
554 */
555//#define MBEDTLS_CHECK_RETURN_WARNING
556
557/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200559 *
560 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200563
564/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000566 *
567 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000570
571/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000573 *
574 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000577
578/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100579 * \def MBEDTLS_CIPHER_MODE_OFB
580 *
581 * Enable Output Feedback mode (OFB) for symmetric ciphers.
582 */
583#define MBEDTLS_CIPHER_MODE_OFB
584
585/**
586 * \def MBEDTLS_CIPHER_MODE_XTS
587 *
588 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
589 */
590#define MBEDTLS_CIPHER_MODE_XTS
591
592/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000594 *
595 * Enable NULL cipher.
596 * Warning: Only do so when you know what you are doing. This allows for
597 * encryption or channels without any security!
598 *
Ronald Croncee42702021-04-26 11:34:44 +0200599 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
601 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
602 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
603 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
604 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
605 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
606 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
607 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
608 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
609 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
610 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
611 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
612 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
613 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
614 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
615 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
616 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
617 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
618 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000619 *
620 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200622//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000623
624/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100625 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200626 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100627 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
628 * specific padding modes in the cipher layer with cipher modes that support
629 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200630 *
631 * If you disable all padding modes, only full blocks can be used with CBC.
632 *
633 * Enable padding modes in the cipher layer.
634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635#define MBEDTLS_CIPHER_PADDING_PKCS7
636#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
637#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
638#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200639
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200640/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
641 *
642 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
643 * By default, CTR_DRBG uses a 256-bit key.
644 */
645//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
646
Paul Bakker48e93c82013-08-14 12:21:18 +0200647/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100648 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200649 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100650 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
651 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200652 *
653 * Comment macros to disable the curve and functions for it
654 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200655/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200656#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
657#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
658#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
659#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
660#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
661#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
662#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
663#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
664#define MBEDTLS_ECP_DP_BP256R1_ENABLED
665#define MBEDTLS_ECP_DP_BP384R1_ENABLED
666#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200667/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200668#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000669#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200670
671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200673 *
674 * Enable specific 'modulo p' routines for each NIST prime.
675 * Depending on the prime and architecture, makes operations 4 to 8 times
676 * faster on the corresponding curve.
677 *
678 * Comment this macro to disable NIST curves optimisation.
679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200681
682/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200683 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100684 *
685 * Enable "non-blocking" ECC operations that can return early and be resumed.
686 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200687 * This allows various functions to pause by returning
688 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
689 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
690 * order to further progress and eventually complete their operation. This is
691 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
692 * number of ECC operations a function may perform before pausing; see
693 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100694 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200695 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200696 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100697 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100698 * This option:
699 * - Adds xxx_restartable() variants of existing operations in the
700 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100701 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
702 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100703 * - ECDSA: signature generation & verification;
704 * - PK: signature generation & verification;
705 * - X509: certificate chain verification.
706 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
707 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
708 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
709 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000710 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100711 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100712 * - verification of the server's key exchange signature;
713 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100714 * - generation of the client's signature if client authentication is used,
715 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100716 *
717 * \note In the cases above, the usual SSL/TLS functions, such as
718 * mbedtls_ssl_handshake(), can now return
719 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200720 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100721 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
722 * restartable operations in PK, X.509 and TLS (see above) are not
723 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100724 * PSA, and are not restartable. These are temporary limitations that
725 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200726 *
Ron Eldor19779c42018-11-05 16:58:13 +0200727 * \note This option only works with the default software implementation of
728 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100729 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100730 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100731 * Requires: MBEDTLS_ECP_C
732 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100733 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100734 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200735//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100736
737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100739 *
740 * Enable deterministic ECDSA (RFC 6979).
741 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
742 * may result in a compromise of the long-term signing key. This is avoided by
743 * the deterministic variant.
744 *
John Durkop36a82e52020-10-26 09:39:05 -0700745 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100746 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100747 * Comment this macro to disable deterministic ECDSA.
748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100750
751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200753 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200754 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200755 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200756 * This enables the following ciphersuites (if other requisites are
757 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
759 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
760 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
763 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
764 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
765 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
766 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
767 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200770
771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200772 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200773 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200774 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200777 *
778 * This enables the following ciphersuites (if other requisites are
779 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
786 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
787 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
788 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
789 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100790 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100791 * \warning Using DHE constitutes a security risk as it
792 * is not possible to validate custom DH parameters.
793 * If possible, it is recommended users should consider
794 * preferring other methods of key exchange.
795 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100796 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200799
800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200801 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200802 *
803 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
804 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200805 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200806 *
807 * This enables the following ciphersuites (if other requisites are
808 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
813 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
814 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200817
818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200819 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200821 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200822 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
824 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200825 *
826 * This enables the following ciphersuites (if other requisites are
827 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
834 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
835 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
836 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
837 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840
841/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200844 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200845 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
847 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200848 *
849 * This enables the following ciphersuites (if other requisites are
850 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
852 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
853 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
857 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
858 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
859 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
861 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
862 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865
866/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200869 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200870 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
872 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200873 *
874 * This enables the following ciphersuites (if other requisites are
875 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
884 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
886 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
887 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100888 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100889 * \warning Using DHE constitutes a security risk as it
890 * is not possible to validate custom DH parameters.
891 * If possible, it is recommended users should consider
892 * preferring other methods of key exchange.
893 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100894 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897
898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200901 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200902 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200903 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
904 * MBEDTLS_RSA_C
905 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200907 *
908 * This enables the following ciphersuites (if other requisites are
909 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
918 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
919 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200920 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200922
923/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200925 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200926 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200927 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200928 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
929 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
930 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200931 *
932 * This enables the following ciphersuites (if other requisites are
933 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
942 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
943 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200946
947/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100949 *
950 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
951 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200952 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
953 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
954 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100955 *
956 * This enables the following ciphersuites (if other requisites are
957 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
966 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
967 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100968 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970
971/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100973 *
974 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
975 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200976 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
977 * MBEDTLS_RSA_C
978 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979 *
980 * This enables the following ciphersuites (if other requisites are
981 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
986 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
987 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
990 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
991 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100992 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100994
995/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200996 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
997 *
998 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
999 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001000 * \warning This is currently experimental. EC J-PAKE support is based on the
1001 * Thread v1.0.0 specification; incompatible changes to the specification
1002 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001003 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001004 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001005 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001006 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1007 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001008 * \warning If SHA-256 is provided only by a PSA driver, you must call
1009 * psa_crypto_init() before the first hanshake (even if
1010 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1011 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001012 * This enables the following ciphersuites (if other requisites are
1013 * enabled as well):
1014 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1015 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001016//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001017
1018/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001020 *
1021 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1022 * RFC 5915 and RFC 5480.
1023 *
1024 * Currently this means parsing the SpecifiedECDomain choice of EC
1025 * parameters (only known groups are supported, not arbitrary domains, to
1026 * avoid validation issues).
1027 *
1028 * Disable if you only need to support RFC 5915 + 5480 key formats.
1029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001031
1032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * Enable a dummy error function to make use of mbedtls_strerror() in
1036 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1037 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1040 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001041 *
1042 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001046
1047/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001049 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001050 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001051 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001055
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001058 *
1059 * Enable functions that use the filesystem.
1060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001062
1063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001065 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001066 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001067 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001068 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001069 * application.
1070 *
1071 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001074
1075/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001077 *
1078 * Do not use built-in platform entropy functions.
1079 * This is useful if your platform does not support
1080 * standards like the /dev/urandom or Windows CryptoAPI.
1081 *
1082 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001085
1086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001088 *
1089 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1090 * default SHA-512 based one (if both are available).
1091 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001093 *
1094 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1095 * if you have performance concerns.
1096 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001097 * This option is only useful if both MBEDTLS_SHA256_C and
1098 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001101
1102/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001103 * \def MBEDTLS_ENTROPY_NV_SEED
1104 *
1105 * Enable the non-volatile (NV) seed file-based entropy source.
1106 * (Also enables the NV seed read/write functions in the platform layer)
1107 *
1108 * This is crucial (if not required) on systems that do not have a
1109 * cryptographic entropy source (in hardware or kernel) available.
1110 *
1111 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1112 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001113 * \note The read/write functions that are used by the entropy source are
1114 * determined in the platform layer, and can be modified at runtime and/or
1115 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1116 *
1117 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001118 * with regular fopen(), please make sure you make a seedfile with the
1119 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1120 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001121 * and written to or you will get an entropy source error! The default
1122 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1123 * bytes from the file.
1124 *
1125 * \note The entropy collector will write to the seed file before entropy is
1126 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001127 */
1128//#define MBEDTLS_ENTROPY_NV_SEED
1129
Ronald Cron71016a92020-08-28 19:01:50 +02001130/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001131 *
Ronald Cron71016a92020-08-28 19:01:50 +02001132 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001133 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001134 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1135 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001136 *
1137 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001138 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001139 */
Ronald Cron71016a92020-08-28 19:01:50 +02001140//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001141
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001144 *
1145 * Enable debugging of buffer allocator memory issues. Automatically prints
1146 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1147 * function for 'debug output' of allocated memory.
1148 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001150 *
1151 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001154
1155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001157 *
1158 * Include backtrace information with each allocated block.
1159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001161 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001162 *
1163 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001166
1167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001169 *
1170 * Support external private RSA keys (eg from a HSM) in the PK layer.
1171 *
1172 * Comment this macro to disable support for external private RSA keys.
1173 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001175
1176/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001178 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001179 * Enable support for PKCS#1 v1.5 encoding.
1180 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001181 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001182 *
Paul Bakker48377d92013-08-30 12:06:24 +02001183 * This enables support for PKCS#1 v1.5 operations.
1184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001186
1187/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001189 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001190 * Enable support for PKCS#1 v2.1 encoding.
1191 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001192 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001193 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001194 * \warning If using a hash that is only provided by PSA drivers, you must
1195 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001196 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001197 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001199#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001200
Steven Cooreman6801f082021-02-19 17:21:22 +01001201/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1202 *
1203 * Enable support for platform built-in keys. If you enable this feature,
1204 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1205 * See the documentation of that function for more information.
1206 *
1207 * Built-in keys are typically derived from a hardware unique key or
1208 * stored in a secure element.
1209 *
1210 * Requires: MBEDTLS_PSA_CRYPTO_C.
1211 *
1212 * \warning This interface is experimental and may change or be removed
1213 * without notice.
1214 */
1215//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1216
Ronald Cron3768ac12021-01-26 16:58:00 +01001217/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1218 *
1219 * Enable support for PSA crypto client.
1220 *
1221 * \note This option allows to include the code necessary for a PSA
1222 * crypto client when the PSA crypto implementation is not included in
1223 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1224 * code to set and get PSA key attributes.
1225 * The development of PSA drivers partially relying on the library to
1226 * fulfill the hardware gaps is another possible usage of this option.
1227 *
1228 * \warning This interface is experimental and may change or be removed
1229 * without notice.
1230 */
1231//#define MBEDTLS_PSA_CRYPTO_CLIENT
1232
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001233/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1234 *
1235 * Make the PSA Crypto module use an external random generator provided
1236 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1237 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001238 * \note This random generator must deliver random numbers with cryptographic
1239 * quality and high performance. It must supply unpredictable numbers
1240 * with a uniform distribution. The implementation of this function
1241 * is responsible for ensuring that the random generator is seeded
1242 * with sufficient entropy. If you have a hardware TRNG which is slow
1243 * or delivers non-uniform output, declare it as an entropy source
1244 * with mbedtls_entropy_add_source() instead of enabling this option.
1245 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001246 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001247 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1248 * and define a function called mbedtls_psa_external_get_random()
1249 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001250 * ```
1251 * psa_status_t mbedtls_psa_external_get_random(
1252 * mbedtls_psa_external_random_context_t *context,
1253 * uint8_t *output, size_t output_size, size_t *output_length);
1254 * );
1255 * ```
1256 * The \c context value is initialized to 0 before the first call.
1257 * The function must fill the \c output buffer with \p output_size bytes
1258 * of random data and set \c *output_length to \p output_size.
1259 *
1260 * Requires: MBEDTLS_PSA_CRYPTO_C
1261 *
1262 * \warning If you enable this option, code that uses the PSA cryptography
1263 * interface will not use any of the entropy sources set up for
1264 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1265 * enables.
1266 *
1267 * \note This option is experimental and may be removed without notice.
1268 */
1269//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1270
Paul Bakker9dcc3222011-03-08 14:16:06 +00001271/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001272 * \def MBEDTLS_PSA_CRYPTO_SPM
1273 *
1274 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1275 * Partition Manager) integration which separates the code into two parts: a
1276 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1277 * Environment).
1278 *
1279 * Module: library/psa_crypto.c
1280 * Requires: MBEDTLS_PSA_CRYPTO_C
1281 *
1282 */
1283//#define MBEDTLS_PSA_CRYPTO_SPM
1284
1285/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001288 * Enable support for entropy injection at first boot. This feature is
1289 * required on systems that do not have a built-in entropy source (TRNG).
1290 * This feature is currently not supported on systems that have a built-in
1291 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
1295 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001296//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001300 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001301 * Do not use the Chinese Remainder Theorem
1302 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001303 *
1304 * Uncomment this macro to disable the use of CRT in RSA.
1305 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001308
1309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001311 *
1312 * Enable the checkup functions (*_self_test).
1313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001315
1316/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001317 * \def MBEDTLS_SHA256_SMALLER
1318 *
1319 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1320 * lower performance.
1321 *
Adam Wolf039080f2019-09-10 09:53:08 -05001322 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001323 * performance and size. This version optimizes more aggressively for size at
1324 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1325 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1326 * 30%.
1327 *
1328 * Uncomment to enable the smaller implementation of SHA256.
1329 */
1330//#define MBEDTLS_SHA256_SMALLER
1331
1332/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001333 * \def MBEDTLS_SHA512_SMALLER
1334 *
1335 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1336 * lower performance.
1337 *
1338 * Uncomment to enable the smaller implementation of SHA512.
1339 */
1340//#define MBEDTLS_SHA512_SMALLER
1341
1342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001344 *
1345 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001346 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001347 * with other servers, only debugging of failures is harder.
1348 *
1349 * The advantage of not sending alert messages, is that no information is given
1350 * about reasons for failures thus preventing adversaries of gaining intel.
1351 *
1352 * Enable sending of all alert messages
1353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001355
1356/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001357 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1358 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001359 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001360 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001361 * in the underlying transport. The CID functionality is described
1362 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001363 *
1364 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001365 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1366 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1367 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001368 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001369 * The maximum lengths of outgoing and incoming CIDs can be configured
1370 * through the options
1371 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1372 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1373 *
1374 * Requires: MBEDTLS_SSL_PROTO_DTLS
1375 *
1376 * Uncomment to enable the Connection ID extension.
1377 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001378#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1379
1380
1381/**
1382 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1383 *
1384 * Defines whether RFC 9146 (default) or the legacy version
1385 * (version draft-ietf-tls-dtls-connection-id-05,
1386 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1387 * is used.
1388 *
1389 * Set the value to 0 for the standard version, and
1390 * 1 for the legacy draft version.
1391 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001392 * \deprecated Support for the legacy version of the DTLS
1393 * Connection ID feature is deprecated. Please
1394 * switch to the standardized version defined
1395 * in RFC 9146 enabled by utilizing
1396 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1397 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1398 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001399 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1400 */
1401#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001402
1403/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001404 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1405 *
1406 * Enable asynchronous external private key operations in SSL. This allows
1407 * you to configure an SSL connection to call an external cryptographic
1408 * module to perform private key operations instead of performing the
1409 * operation inside the library.
1410 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001411 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001412 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001413//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001414
1415/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001416 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1417 *
1418 * Enable serialization of the TLS context structures, through use of the
1419 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1420 *
1421 * This pair of functions allows one side of a connection to serialize the
1422 * context associated with the connection, then free or re-use that context
1423 * while the serialized state is persisted elsewhere, and finally deserialize
1424 * that state to a live context for resuming read/write operations on the
1425 * connection. From a protocol perspective, the state of the connection is
1426 * unaffected, in particular this is entirely transparent to the peer.
1427 *
1428 * Note: this is distinct from TLS session resumption, which is part of the
1429 * protocol and fully visible by the peer. TLS session resumption enables
1430 * establishing new connections associated to a saved session with shorter,
1431 * lighter handshakes, while context serialization is a local optimization in
1432 * handling a single, potentially long-lived connection.
1433 *
1434 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1435 * saved after the handshake to allow for more efficient serialization, so if
1436 * you don't need this feature you'll save RAM by disabling it.
1437 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001438 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1439 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001440 * Comment to disable the context serialization APIs.
1441 */
1442#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1443
1444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001445 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001446 *
1447 * Enable the debug messages in SSL module for all issues.
1448 * Debug messages have been disabled in some places to prevent timing
1449 * attacks due to (unbalanced) debugging function calls.
1450 *
1451 * If you need all error reporting you should enable this during debugging,
1452 * but remove this for production servers that should log as well.
1453 *
1454 * Uncomment this macro to report all debug messages on errors introducing
1455 * a timing side-channel.
1456 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001461 *
1462 * Enable support for Encrypt-then-MAC, RFC 7366.
1463 *
1464 * This allows peers that both support it to use a more robust protection for
1465 * ciphersuites using CBC, providing deep resistance against timing attacks
1466 * on the padding or underlying cipher.
1467 *
1468 * This only affects CBC ciphersuites, and is useless if none is defined.
1469 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001470 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001471 *
1472 * Comment this macro to disable support for Encrypt-then-MAC
1473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001477 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001478 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1479 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001480 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001481 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001482 * attacks, but it is recommended to always use it (even if you disable
1483 * renegotiation), since it actually fixes a more fundamental issue in the
1484 * original SSL/TLS design, and has implications beyond Triple Handshake.
1485 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001486 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001487 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001488 * Comment this macro to disable support for Extended Master Secret.
1489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001491
Paul Bakkerd66f0702013-01-31 16:57:45 +01001492/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001493 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1494 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001495 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001496 * giving access to the peer's certificate after completion of the handshake.
1497 *
1498 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1499 * recommended to disable this option for reduced RAM usage.
1500 *
1501 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1502 * defined, but always returns \c NULL.
1503 *
1504 * \note This option has no influence on the protection against the
1505 * triple handshake attack. Even if it is disabled, Mbed TLS will
1506 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001507 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001508 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001509 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1510 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001511 * Comment this macro to disable storing the peer's certificate
1512 * after the handshake.
1513 */
1514#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1515
1516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001518 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001519 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001520 *
1521 * The two main uses of renegotiation are (1) refresh keys on long-lived
1522 * connections and (2) client authentication after the initial handshake.
1523 * If you don't need renegotiation, it's probably better to disable it, since
1524 * it has been associated with security issues in the past and is easy to
1525 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001526 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001527 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001528 *
1529 * \note Even if this option is disabled, both client and server are aware
1530 * of the Renegotiation Indication Extension (RFC 5746) used to
1531 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1532 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1533 * configuration of this extension).
1534 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001535 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001537
1538/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001540 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001541 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001542 *
1543 * Comment this macro to disable support for the max_fragment_length extension
1544 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001546
1547/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001548 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1549 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001550 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001551 *
1552 * \warning This extension is currently in development and must NOT be used except
1553 * for testing purposes.
1554 *
1555 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1556 *
1557 * Uncomment this macro to enable support for the record_size_limit extension
1558 */
1559//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1560
1561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001563 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001564 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001565 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001566 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001567 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1568 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001569 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001570 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001571 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001572 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1573 * are only provided by PSA drivers, you must call psa_crypto_init() before
1574 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001575 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001576 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001577 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001579
1580/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001581 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001582 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001583 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001584 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001585 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1586 * pre-shared keys are not supported.
1587 * See docs/architecture/tls13-support.md for a description of the TLS
1588 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001589 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001590 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001591 * Requires: MBEDTLS_PSA_CRYPTO_C
1592 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001593 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1594 * directly performed by TLS 1.3 code. As a consequence, you must
1595 * call psa_crypto_init() before the first TLS 1.3 handshake.
1596 *
1597 * \note Cryptographic operations performed indirectly via another module
1598 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1599 * running handshake hash) only use PSA crypto if
1600 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001601 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001602 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001603 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001604//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605
1606/**
Ronald Cronab65c522021-11-24 10:47:20 +01001607 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1608 *
1609 * Enable TLS 1.3 middlebox compatibility mode.
1610 *
1611 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1612 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1613 * expecting TLS 1.2 traffic.
1614 *
1615 * Turning on the compatibility mode comes at the cost of a few added bytes
1616 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1617 * that don't use it. Therefore, unless transmission bandwidth is critical and
1618 * you know that middlebox compatibility issues won't occur, it is therefore
1619 * recommended to set this option.
1620 *
1621 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001622 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1623 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001624 *
1625 */
1626//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1627
1628/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001629 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1630 *
1631 * Enable TLS 1.3 PSK key exchange mode.
1632 *
1633 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1634 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1635 * effect on the build.
1636 *
1637 */
1638#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1639
1640/**
1641 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1642 *
1643 * Enable TLS 1.3 ephemeral key exchange mode.
1644 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001645 * Requires: PSA_WANT_ALG_ECDH
1646 * MBEDTLS_X509_CRT_PARSE_C
1647 * and at least one of:
1648 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1649 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001650 *
1651 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1652 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1653 * effect on the build.
1654 *
1655 */
1656#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1657
1658/**
1659 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1660 *
1661 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1662 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001663 * Requires: PSA_WANT_ALG_ECDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001664 *
1665 * Comment to disable support for the PSK ephemeral key exchange mode in
1666 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1667 * have any effect on the build.
1668 *
1669 */
1670#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1671
1672/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 * \def MBEDTLS_SSL_EARLY_DATA
1674 *
1675 * Enable support for RFC 8446 TLS 1.3 early data.
1676 *
1677 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1678 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1679 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1680 *
1681 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1682 * is not enabled, this option does not have any effect on the build.
1683 *
1684 * This feature is experimental, not completed and thus not ready for
1685 * production.
1686 *
1687 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001688//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001689
1690/**
Jerry Yu16f68532022-11-05 10:50:06 +08001691 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1692 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001693 * The default maximum amount of 0-RTT data. See the documentation of
1694 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1695 *
1696 * It must be positive and smaller than UINT32_MAX.
1697 *
1698 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1699 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001700 *
1701 * This feature is experimental, not completed and thus not ready for
1702 * production.
1703 *
1704 */
1705#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001709 *
1710 * Enable support for DTLS (all available versions).
1711 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001714 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 *
1716 * Comment this macro to disable support for DTLS
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001719
1720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001722 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001723 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001725 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 *
1732 * Enable support for the anti-replay mechanism in DTLS.
1733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * Requires: MBEDTLS_SSL_TLS_C
1735 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001736 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001738 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001739 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001740 * Comment this to disable anti-replay in DTLS.
1741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743
1744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001746 *
1747 * Enable support for HelloVerifyRequest on DTLS servers.
1748 *
1749 * This feature is highly recommended to prevent DTLS servers being used as
1750 * amplifiers in DoS attacks against other hosts. It should always be enabled
1751 * unless you know for sure amplification cannot be a problem in the
1752 * environment in which your server operates.
1753 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001754 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001755 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001756 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001757 *
1758 * Comment this to disable support for HelloVerifyRequest.
1759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001761
1762/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001763 * \def MBEDTLS_SSL_DTLS_SRTP
1764 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001765 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001766 * through the use_srtp extension.
1767 *
1768 * \note This feature provides the minimum functionality required
1769 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1770 * the associated SRTP packet protection key material.
1771 * In particular, the SRTP packet protection itself, as well as the
1772 * demultiplexing of RTP and DTLS packets at the datagram layer
1773 * (see Section 5 of RFC 5764), are not handled by this feature.
1774 * Instead, after successful completion of a handshake negotiating
1775 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001776 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001777 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1778 * (this is implemented in the SSL example programs).
1779 * The resulting key should then be passed to an SRTP stack.
1780 *
1781 * Setting this option enables the runtime API
1782 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1783 * through which the supported DTLS-SRTP protection
1784 * profiles can be configured. You must call this API at
1785 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001786 *
1787 * Requires: MBEDTLS_SSL_PROTO_DTLS
1788 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001789 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001790 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001791//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001792
1793/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001794 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1795 *
1796 * Enable server-side support for clients that reconnect from the same port.
1797 *
1798 * Some clients unexpectedly close the connection and try to reconnect using the
1799 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001800 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001801 * flag enables that support.
1802 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001803 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001804 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001805 * Comment this to disable support for clients reusing the source port.
1806 */
1807#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001812 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001813 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001814 * session store remains the responsibility of the application, though).
1815 * Server-side, you also need to provide callbacks for writing and parsing
1816 * tickets, including authenticated encryption and key management. Example
1817 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001818 *
1819 * Comment this macro to disable support for SSL session tickets
1820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001822
1823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001826 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001829 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001830 * Comment this macro to disable support for server name indication in SSL
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001833
1834/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001835 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1836 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001837 * When this option is enabled, the SSL buffer will be resized automatically
1838 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001839 *
1840 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001841 */
1842//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1843
1844/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001845 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1846 *
1847 * Enable testing of the constant-flow nature of some sensitive functions with
1848 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001849 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001850 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * This setting requires compiling with clang -fsanitize=memory. The test
1852 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001853 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001854 * \warning This macro is only used for extended testing; it is not considered
1855 * part of the library's API, so it may change or disappear at any time.
1856 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001857 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001858 */
1859//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1860
1861/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001862 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1863 *
1864 * Enable testing of the constant-flow nature of some sensitive functions with
1865 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001866 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001867 *
1868 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001869 * testing if the tests suites are run with valgrind's memcheck. This can be
1870 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1871 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001872 *
1873 * \warning This macro is only used for extended testing; it is not considered
1874 * part of the library's API, so it may change or disappear at any time.
1875 *
1876 * Uncomment to enable testing of the constant-flow nature of selected code.
1877 */
1878//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1879
1880/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001881 * \def MBEDTLS_TEST_HOOKS
1882 *
1883 * Enable features for invasive testing such as introspection functions and
1884 * hooks for fault injection. This enables additional unit tests.
1885 *
1886 * Merely enabling this feature should not change the behavior of the product.
1887 * It only adds new code, and new branching points where the default behavior
1888 * is the same as when this feature is disabled.
1889 * However, this feature increases the attack surface: there is an added
1890 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1891 * Therefore this feature must never be enabled in production.
1892 *
1893 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1894 * information.
1895 *
1896 * Uncomment to enable invasive tests.
1897 */
1898//#define MBEDTLS_TEST_HOOKS
1899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001902 *
1903 * Provide your own alternate threading implementation.
1904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001906 *
1907 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001910
1911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001913 *
1914 * Enable the pthread wrapper layer for the threading layer.
1915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001917 *
1918 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001921
1922/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001923 * \def MBEDTLS_USE_PSA_CRYPTO
1924 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001925 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1926 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001928 * \note Development of this option is currently in progress, and parts of Mbed
1929 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001930 * will still continue to work as usual, so enabling this option should not
1931 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001932 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001933 * \warning If you enable this option, you need to call `psa_crypto_init()`
1934 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001935 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001936 * \note An important and desirable effect of this option is that it allows
1937 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1938 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02001939 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001940 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1941 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001942 *
1943 * \note See docs/use-psa-crypto.md for a complete description this option.
1944 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001945 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001946 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001947 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001948 */
1949//#define MBEDTLS_USE_PSA_CRYPTO
1950
1951/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001952 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1953 *
John Durkop185764f2020-10-12 21:32:12 -07001954 * This setting allows support for cryptographic mechanisms through the PSA
1955 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001956 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001957 * When this option is disabled, the PSA API exposes the cryptographic
1958 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1959 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001960 *
1961 * When this option is enabled, the PSA API exposes the cryptographic
1962 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1963 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1964 * automatically enabled if required (i.e. if no PSA driver provides the
1965 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1966 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001967 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001968 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001969 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001970 *
John Durkop185764f2020-10-12 21:32:12 -07001971 * This feature is still experimental and is not ready for production since
1972 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001973 */
1974//#define MBEDTLS_PSA_CRYPTO_CONFIG
1975
1976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001978 *
1979 * Allow run-time checking of compile-time enabled features. Thus allowing users
1980 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001982 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001984 *
1985 * Comment this to disable run-time checking and save ROM space
1986 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001988
1989/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001990 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1991 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001992 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001993 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1994 * the set of trusted certificates through a callback instead of a linked
1995 * list.
1996 *
1997 * This is useful for example in environments where a large number of trusted
1998 * certificates is present and storing them in a linked list isn't efficient
1999 * enough, or when the set of trusted certificates changes frequently.
2000 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002001 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002002 * `mbedtls_ssl_conf_ca_cb()` for more information.
2003 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002004 * Requires: MBEDTLS_X509_CRT_PARSE_C
2005 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002006 * Uncomment to enable trusted certificate callbacks.
2007 */
2008//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2009
2010/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002011 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002012 *
Chris Jones2c745862020-12-16 11:41:06 +00002013 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002014 *
Chris Jones2c745862020-12-16 11:41:06 +00002015 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002016 * and other functions/constants only used by these functions, thus reducing
2017 * the code footprint by several KB.
2018 */
Chris Jones2c745862020-12-16 11:41:06 +00002019//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002020
2021/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002023 *
2024 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2025 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2026 *
2027 * Comment this macro to disallow using RSASSA-PSS in certificates.
2028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002030/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002031
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002032/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002033 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002034 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002035 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002036 * \{
2037 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002038
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002041 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002042 * Enable AES-NI support on x86-64 or x86-32.
2043 *
2044 * \note AESNI is only supported with certain compilers and target options:
2045 * - Visual Studio 2013: supported.
2046 * - GCC, x86-64, target not explicitly supporting AESNI:
2047 * requires MBEDTLS_HAVE_ASM.
2048 * - GCC, x86-32, target not explicitly supporting AESNI:
2049 * not supported.
2050 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2051 * For this assembly-less implementation, you must currently compile
2052 * `library/aesni.c` and `library/aes.c` with machine options to enable
2053 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2054 * `clang -maes -mpclmul`.
2055 * - Non-x86 targets: this option is silently ignored.
2056 * - Other compilers: this option is silently ignored.
2057 *
2058 * \note
2059 * Above, "GCC" includes compatible compilers such as Clang.
2060 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002061 *
2062 * Module: library/aesni.c
2063 * Caller: library/aes.c
2064 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002065 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002066 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002067 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002070
2071/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002072 * \def MBEDTLS_AESCE_C
2073 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002074 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002075 *
2076 * Module: library/aesce.c
2077 * Caller: library/aes.c
2078 *
Jerry Yuf015a932023-04-25 10:38:03 +08002079 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002080 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002081 * \warning Runtime detection only works on Linux. For non-Linux operating
2082 * system, Armv8-A Cryptographic Extensions must be supported by
2083 * the CPU when this option is enabled.
Jerry Yu330e6ae2023-02-21 14:51:38 +08002084 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002085 * \note Minimum compiler versions for this feature are Clang 4.0,
2086 * GCC 6.0 or MSVC 2019 version 16.11.2.
Jerry Yuf015a932023-04-25 10:38:03 +08002087 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002088 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 */
2090#define MBEDTLS_AESCE_C
2091
2092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002093 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002094 *
2095 * Enable the AES block cipher.
2096 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002097 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002098 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002099 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002100 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002101 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002102 * This module enables the following ciphersuites (if other requisites are
2103 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002104 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2105 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2106 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2107 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2108 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2109 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2110 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2111 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2112 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2113 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2114 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2115 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2116 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2117 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2118 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2119 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2120 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2121 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2122 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2124 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2125 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2126 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2127 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2128 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2129 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2130 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2131 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2132 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2133 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2134 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2136 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2137 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2138 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2139 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2140 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2141 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2142 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2143 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2144 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2145 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2146 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2147 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2148 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2149 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2151 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2152 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2153 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2154 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2155 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2156 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2157 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2158 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2159 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2160 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2161 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002162 *
Paul Bakkercff68422013-09-15 20:43:33 +02002163 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002164 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002165#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002166
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002167/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002168 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002169 *
2170 * Enable the generic ASN1 parser.
2171 *
2172 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002173 * Caller: library/x509.c
2174 * library/dhm.c
2175 * library/pkcs12.c
2176 * library/pkcs5.c
2177 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002180
2181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002183 *
2184 * Enable the generic ASN1 writer.
2185 *
2186 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002187 * Caller: library/ecdsa.c
2188 * library/pkwrite.c
2189 * library/x509_create.c
2190 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002191 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002194
2195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002197 *
2198 * Enable the Base64 module.
2199 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002200 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002201 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002202 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002203 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002204 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002209 *
Paul Bakker9a736322012-11-14 12:39:52 +00002210 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002211 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002212 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002213 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002214 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002215 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002216 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002217 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002218 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002220 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002221 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002223 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002226
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002228 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002229 *
2230 * Enable the Camellia block cipher.
2231 *
Paul Bakker38119b12009-01-10 23:31:23 +00002232 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002233 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002234 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002235 * This module enables the following ciphersuites (if other requisites are
2236 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2238 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2239 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2240 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2241 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2242 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2243 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2244 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2245 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2246 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2247 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2248 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2249 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2250 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2251 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2252 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2253 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2254 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2255 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2256 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2258 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2259 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2261 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2262 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2264 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2265 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2266 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2267 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2268 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2269 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2270 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2271 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2272 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2273 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2274 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2276 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2277 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2278 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002279 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002281
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002282/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002283 * \def MBEDTLS_ARIA_C
2284 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002285 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002286 *
2287 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002288 * Caller: library/cipher.c
2289 *
2290 * This module enables the following ciphersuites (if other requisites are
2291 * enabled as well):
2292 *
2293 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2294 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2295 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2296 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2297 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2299 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2300 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2301 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2303 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2304 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2306 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2307 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2308 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2309 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2310 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2311 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2312 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2313 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2314 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2315 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2316 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2317 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2318 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2319 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2320 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2321 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2322 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2323 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2324 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2325 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2326 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2327 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2328 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2329 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002331 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002332#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002333
2334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002336 *
2337 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2338 *
2339 * Module: library/ccm.c
2340 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002341 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2342 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002343 *
2344 * This module enables the AES-CCM ciphersuites, if other requisites are
2345 * enabled as well.
2346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002348
2349/**
Daniel King34b822c2016-05-15 17:28:08 -03002350 * \def MBEDTLS_CHACHA20_C
2351 *
2352 * Enable the ChaCha20 stream cipher.
2353 *
2354 * Module: library/chacha20.c
2355 */
2356#define MBEDTLS_CHACHA20_C
2357
2358/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002359 * \def MBEDTLS_CHACHAPOLY_C
2360 *
2361 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2362 *
2363 * Module: library/chachapoly.c
2364 *
2365 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2366 */
2367#define MBEDTLS_CHACHAPOLY_C
2368
2369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002371 *
2372 * Enable the generic cipher layer.
2373 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002374 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002375 * Caller: library/ccm.c
2376 * library/cmac.c
2377 * library/gcm.c
2378 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002379 * library/pkcs12.c
2380 * library/pkcs5.c
2381 * library/psa_crypto_aead.c
2382 * library/psa_crypto_mac.c
2383 * library/ssl_ciphersuites.c
2384 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002385 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002386 *
2387 * Uncomment to enable generic cipher wrappers.
2388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002390
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002391/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002392 * \def MBEDTLS_CMAC_C
2393 *
Simon Butcher327398a2016-10-05 14:09:11 +01002394 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2395 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002396 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002397 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2398 * implementation of the CMAC algorithm is provided by an alternate
2399 * implementation, that alternate implementation may opt to not support
2400 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2401 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002402 * Module: library/cmac.c
2403 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002404 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002405 *
2406 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002407#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002408
2409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002410 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002411 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002412 * Enable the CTR_DRBG AES-based random generator.
2413 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002414 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002415 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002416 * \note To achieve a 256-bit security strength with CTR_DRBG,
2417 * you must use AES-256 *and* use sufficient entropy.
2418 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002419 *
2420 * Module: library/ctr_drbg.c
2421 * Caller:
2422 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002424 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002425 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002428
2429/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002431 *
2432 * Enable the debug functions.
2433 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002434 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002435 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002436 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002437 * library/ssl_tls12_*.c
2438 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002439 *
2440 * This module provides debugging functions.
2441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002443
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002444/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002445 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002446 *
2447 * Enable the DES block cipher.
2448 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002449 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002450 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002451 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002452 *
Paul Bakkercff68422013-09-15 20:43:33 +02002453 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002454 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002455 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002456 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002459
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002462 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002463 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002464 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002465 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002466 * Caller: library/ssl_tls.c
2467 * library/ssl*_client.c
2468 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002469 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002470 * This module is used by the following key exchanges:
2471 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002472 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002473 * \warning Using DHE constitutes a security risk as it
2474 * is not possible to validate custom DH parameters.
2475 * If possible, it is recommended users should consider
2476 * preferring other methods of key exchange.
2477 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002478 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002481
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002483 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002484 *
2485 * Enable the elliptic curve Diffie-Hellman library.
2486 *
2487 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002488 * Caller: library/psa_crypto.c
2489 * library/ssl_tls.c
2490 * library/ssl*_client.c
2491 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002492 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002493 * This module is used by the following key exchanges:
2494 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002495 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002497 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002499
2500/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002502 *
2503 * Enable the elliptic curve DSA library.
2504 *
2505 * Module: library/ecdsa.c
2506 * Caller:
2507 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002508 * This module is used by the following key exchanges:
2509 * ECDHE-ECDSA
2510 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002511 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2512 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2513 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002516
2517/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002518 * \def MBEDTLS_ECJPAKE_C
2519 *
2520 * Enable the elliptic curve J-PAKE library.
2521 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002522 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2523 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002524 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002525 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002526 * Module: library/ecjpake.c
2527 * Caller:
2528 *
2529 * This module is used by the following key exchanges:
2530 * ECJPAKE
2531 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002532 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002533 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002534 * \warning If using a hash that is only provided by PSA drivers, you must
2535 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002536 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002537#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002538
2539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541 *
2542 * Enable the elliptic curve over GF(p) library.
2543 *
2544 * Module: library/ecp.c
2545 * Caller: library/ecdh.c
2546 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002547 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002548 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002550 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002551#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002552
2553/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002555 *
2556 * Enable the platform-specific entropy code.
2557 *
2558 * Module: library/entropy.c
2559 * Caller:
2560 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002562 *
2563 * This module provides a generic entropy pool
2564 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002565#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002566
2567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002569 *
2570 * Enable error code to error string conversion.
2571 *
2572 * Module: library/error.c
2573 * Caller:
2574 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002578
2579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002581 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002582 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002583 *
2584 * Module: library/gcm.c
2585 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002586 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2587 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002588 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002589 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2590 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002591 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002592#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002593
2594/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002595 * \def MBEDTLS_HKDF_C
2596 *
2597 * Enable the HKDF algorithm (RFC 5869).
2598 *
2599 * Module: library/hkdf.c
2600 * Caller:
2601 *
2602 * Requires: MBEDTLS_MD_C
2603 *
2604 * This module adds support for the Hashed Message Authentication Code
2605 * (HMAC)-based key derivation function (HKDF).
2606 */
2607#define MBEDTLS_HKDF_C
2608
2609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002611 *
2612 * Enable the HMAC_DRBG random generator.
2613 *
2614 * Module: library/hmac_drbg.c
2615 * Caller:
2616 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002617 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002618 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002619 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002622
2623/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002624 * \def MBEDTLS_LMS_C
2625 *
2626 * Enable the LMS stateful-hash asymmetric signature algorithm.
2627 *
2628 * Module: library/lms.c
2629 * Caller:
2630 *
Raef Colesab4f8742022-09-01 12:24:31 +01002631 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002632 *
Raef Colesab4f8742022-09-01 12:24:31 +01002633 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002634 */
2635#define MBEDTLS_LMS_C
2636
2637/**
Raef Colesab4f8742022-09-01 12:24:31 +01002638 * \def MBEDTLS_LMS_PRIVATE
2639 *
2640 * Enable LMS private-key operations and signing code. Functions enabled by this
2641 * option are experimental, and should not be used in production.
2642 *
2643 * Requires: MBEDTLS_LMS_C
2644 *
2645 * Uncomment to enable the LMS signature algorithm and private key operations.
2646 */
Raef Coles5127e852022-10-07 10:35:56 +01002647//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002648
2649/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002650 * \def MBEDTLS_NIST_KW_C
2651 *
2652 * Enable the Key Wrapping mode for 128-bit block ciphers,
2653 * as defined in NIST SP 800-38F. Only KW and KWP modes
2654 * are supported. At the moment, only AES is approved by NIST.
2655 *
2656 * Module: library/nist_kw.c
2657 *
2658 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2659 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002660#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002661
2662/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002664 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002665 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002666 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002667 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2668 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002669 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002670 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002671 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002672 * Caller: library/constant_time.c
2673 * library/ecdsa.c
2674 * library/ecjpake.c
2675 * library/hkdf.c
2676 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002677 * library/pk.c
2678 * library/pkcs5.c
2679 * library/pkcs12.c
2680 * library/psa_crypto_ecp.c
2681 * library/psa_crypto_rsa.c
2682 * library/rsa.c
2683 * library/ssl_cookie.c
2684 * library/ssl_msg.c
2685 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002686 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002687 * library/x509_crt.c
2688 * library/x509write_crt.c
2689 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002690 *
2691 * Uncomment to enable generic message digest wrappers.
2692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002694
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002695/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002696 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002697 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002698 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002699 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002700 * Module: library/md5.c
2701 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002702 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002703 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002705 * This module is required for TLS 1.2 depending on the handshake parameters.
2706 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2707 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002708 *
2709 * \warning MD5 is considered a weak message digest and its use constitutes a
2710 * security risk. If possible, we recommend avoiding dependencies on
2711 * it, and considering stronger message digests instead.
2712 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002713 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002715
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002716/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002717 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002718 *
2719 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002720 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002721 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002722 *
2723 * Module: library/memory_buffer_alloc.c
2724 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 * Requires: MBEDTLS_PLATFORM_C
2726 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002727 *
2728 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002731
2732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002734 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002735 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2736 *
Simon Butcherd567a232016-03-09 20:19:21 +00002737 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2738 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002739 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002740 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002741 * \note See also our Knowledge Base article about porting to a new
2742 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002743 * 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 +00002744 *
Andres AG788aa4a2016-09-14 14:32:09 +01002745 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002746 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002747 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002750
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002753 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002754 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002755 *
2756 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002757 * Caller: library/asn1write.c
2758 * library/pkcs5.c
2759 * library/pkparse.c
2760 * library/pkwrite.c
2761 * library/rsa.c
2762 * library/x509.c
2763 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002764 * library/x509_crl.c
2765 * library/x509_crt.c
2766 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002767 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002768 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002769 *
2770 * This modules translates between OIDs and internal values.
2771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002773
2774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002776 *
2777 * Enable VIA Padlock support on x86.
2778 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002779 * Module: library/padlock.c
2780 * Caller: library/aes.c
2781 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002783 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002784 * This modules adds support for the VIA PadLock on x86.
2785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002787
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002790 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002791 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002792 *
2793 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002794 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002795 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002796 * library/x509_crl.c
2797 * library/x509_crt.c
2798 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002799 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002801 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2802 *
2803 * \warning When parsing password-protected files, if MD5 is provided only by
2804 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002805 *
Paul Bakkercff68422013-09-15 20:43:33 +02002806 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002809
2810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002812 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002813 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002814 *
2815 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002816 * Caller: library/pkwrite.c
2817 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002818 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002819 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002821 *
2822 * This modules adds support for encoding / writing PEM files.
2823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002825
2826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002828 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002829 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002830 *
2831 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002832 * Caller: library/psa_crypto_rsa.c
2833 * library/ssl_tls.c
2834 * library/ssl*_client.c
2835 * library/ssl*_server.c
2836 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002837 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002838 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002839 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002840 * Uncomment to enable generic public key wrappers.
2841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002843
2844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002846 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002847 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002848 *
2849 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002850 * Caller: library/x509_crt.c
2851 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002852 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002854 *
2855 * Uncomment to enable generic public key parse functions.
2856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002858
2859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002861 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002862 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002863 *
2864 * Module: library/pkwrite.c
2865 * Caller: library/x509write.c
2866 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002868 *
2869 * Uncomment to enable generic public key write functions.
2870 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002872
2873/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002875 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002876 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002877 *
2878 * Module: library/pkcs5.c
2879 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002880 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002881 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002882 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002883 * \warning If using a hash that is only provided by PSA drivers, you must
2884 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002885 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002886 * This module adds support for the PKCS#5 functions.
2887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002889
2890/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002891 * \def MBEDTLS_PKCS7_C
2892 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002893 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002894 * RFC Link - https://tools.ietf.org/html/rfc2315
2895 *
2896 * Module: library/pkcs7.c
2897 *
2898 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002899 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2900 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002901 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002902 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002903 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002904#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002905
2906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002908 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002909 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002910 * Adds algorithms for parsing PKCS#8 encrypted private keys
2911 *
2912 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002913 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002914 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002915 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2916 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2917 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002918 * \warning If using a hash that is only provided by PSA drivers, you must
2919 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002920 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002921 * This module enables PKCS#12 functions.
2922 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002924
2925/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002927 *
2928 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002929 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002930 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2932 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002933 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002934 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002935 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002936 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002937 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002938 * Module: library/platform.c
2939 * Caller: Most other .c files
2940 *
2941 * This module enables abstraction of common (libc) functions.
2942 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002943#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002944
2945/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002946 * \def MBEDTLS_POLY1305_C
2947 *
2948 * Enable the Poly1305 MAC algorithm.
2949 *
2950 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002951 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002952 */
2953#define MBEDTLS_POLY1305_C
2954
2955/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002956 * \def MBEDTLS_PSA_CRYPTO_C
2957 *
2958 * Enable the Platform Security Architecture cryptography API.
2959 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002960 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002961 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002962 * Requires: MBEDTLS_CIPHER_C,
2963 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002964 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002965 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002966 *
2967 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002968#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002969
2970/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002971 * \def MBEDTLS_PSA_CRYPTO_SE_C
2972 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002973 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002974 * cryptography API.
2975 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002976 * \deprecated This feature is deprecated. Please switch to the PSA driver
2977 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002978 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002979 * Module: library/psa_crypto_se.c
2980 *
2981 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2982 *
2983 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002984//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002985
2986/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002987 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2988 *
2989 * Enable the Platform Security Architecture persistent key storage.
2990 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002991 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002992 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002993 * Requires: MBEDTLS_PSA_CRYPTO_C,
2994 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2995 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002996 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002997#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002998
2999/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003000 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003001 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003002 * Enable the emulation of the Platform Security Architecture
3003 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003004 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003005 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003006 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003007 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003008 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003009#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003010
3011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003013 *
3014 * Enable the RIPEMD-160 hash algorithm.
3015 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003016 * Module: library/ripemd160.c
3017 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003018 *
3019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003021
3022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003024 *
3025 * Enable the RSA public-key cryptosystem.
3026 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003027 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003028 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003029 * Caller: library/pk.c
3030 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003031 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003032 * library/ssl*_client.c
3033 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003034 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003035 * This module is used by the following key exchanges:
3036 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003038 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003041
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003042/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003044 *
3045 * Enable the SHA1 cryptographic hash algorithm.
3046 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003047 * Module: library/sha1.c
3048 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003049 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003051 * This module is required for TLS 1.2 depending on the handshake parameters,
3052 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003053 *
3054 * \warning SHA-1 is considered a weak message digest and its use constitutes
3055 * a security risk. If possible, we recommend avoiding dependencies
3056 * on it, and considering stronger message digests instead.
3057 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003062 * \def MBEDTLS_SHA224_C
3063 *
3064 * Enable the SHA-224 cryptographic hash algorithm.
3065 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003066 * Module: library/sha256.c
3067 * Caller: library/md.c
3068 * library/ssl_cookie.c
3069 *
3070 * This module adds support for SHA-224.
3071 */
3072#define MBEDTLS_SHA224_C
3073
3074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003076 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003077 * Enable the SHA-256 cryptographic hash algorithm.
3078 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003079 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003080 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003081 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003082 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003083 * library/ssl*_client.c
3084 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003085 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003086 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003087 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003089#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003090
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003091/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003092 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3093 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003094 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3095 * with the ARMv8 cryptographic extensions if they are available at runtime.
3096 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003097 *
3098 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3099 * for a non-Aarch64 build it will be silently ignored.
3100 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003101 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3102 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3103 *
3104 * Requires: MBEDTLS_SHA256_C.
3105 *
3106 * Module: library/sha256.c
3107 *
3108 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3109 * and use them if available.
3110 */
3111//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3112
3113/**
3114 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3115 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003116 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3117 * with the ARMv8 cryptographic extensions, which must be available at runtime
3118 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003119 *
3120 * \note This allows builds with a smaller code size than with
3121 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3122 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003123 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3124 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3125 *
3126 * Requires: MBEDTLS_SHA256_C.
3127 *
3128 * Module: library/sha256.c
3129 *
3130 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3131 * unconditionally.
3132 */
3133//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3134
3135/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003136 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003137 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003138 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003139 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003140 * Module: library/sha512.c
3141 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003142 * library/psa_crypto_hash.c
3143 * library/ssl_tls.c
3144 * library/ssl*_client.c
3145 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003146 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003147 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003148 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003149#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003150
3151/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003152 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003153 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003154 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003155 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003156 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003157 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003158 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003159 * library/ssl_tls.c
3160 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003161 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003162 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003165
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003166/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003167 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3168 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003169 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3170 * with the ARMv8 cryptographic extensions if they are available at runtime.
3171 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003172 *
3173 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3174 * for a non-Aarch64 build it will be silently ignored.
3175 *
3176 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003177 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003178 *
3179 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3180 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3181 *
3182 * Requires: MBEDTLS_SHA512_C.
3183 *
3184 * Module: library/sha512.c
3185 *
3186 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3187 * and use them if available.
3188 */
3189//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3190
3191/**
3192 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3193 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003194 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3195 * with the ARMv8 cryptographic extensions, which must be available at runtime
3196 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003197 *
3198 * \note This allows builds with a smaller code size than with
3199 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3200 *
3201 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003202 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003203 *
3204 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3205 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3206 *
3207 * Requires: MBEDTLS_SHA512_C.
3208 *
3209 * Module: library/sha512.c
3210 *
3211 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3212 * unconditionally.
3213 */
3214//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3215
3216/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003217 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003218 *
3219 * Enable simple SSL cache implementation.
3220 *
3221 * Module: library/ssl_cache.c
3222 * Caller:
3223 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003224 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003227
3228/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003230 *
3231 * Enable basic implementation of DTLS cookies for hello verification.
3232 *
3233 * Module: library/ssl_cookie.c
3234 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003235 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003237
3238/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003239 * \def MBEDTLS_SSL_TICKET_C
3240 *
3241 * Enable an implementation of TLS server-side callbacks for session tickets.
3242 *
3243 * Module: library/ssl_ticket.c
3244 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003245 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003246 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3247 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003248 */
3249#define MBEDTLS_SSL_TICKET_C
3250
3251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003253 *
3254 * Enable the SSL/TLS client code.
3255 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003256 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 * Caller:
3258 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003260 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003261 * This module is required for SSL/TLS client support.
3262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003264
Paul Bakker9a736322012-11-14 12:39:52 +00003265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003267 *
3268 * Enable the SSL/TLS server code.
3269 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003270 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003271 * Caller:
3272 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003274 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003275 * This module is required for SSL/TLS server support.
3276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003278
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003281 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003282 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003283 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003284 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003285 * Caller: library/ssl*_client.c
3286 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003287 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3289 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003290 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003291 * This module is required for SSL/TLS.
3292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003294
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003295/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003297 *
3298 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003299 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003300 * contexts are not shared between threads. If you do intend to use contexts
3301 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003302 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003303 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003304 *
3305 * Module: library/threading.c
3306 *
3307 * This allows different threading implementations (self-implemented or
3308 * provided).
3309 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 * You will have to enable either MBEDTLS_THREADING_ALT or
3311 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003312 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003313 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003316
3317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003319 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003320 * Enable the semi-portable timing interface.
3321 *
Simon Butcherd567a232016-03-09 20:19:21 +00003322 * \note The provided implementation only works on POSIX/Unix (including Linux,
3323 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003324 * module and provide your own implementations of the callbacks needed by
3325 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3326 * your own implementation of the whole module by setting
3327 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003328 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003329 * \note The timing module will include time.h on suitable platforms
3330 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3331 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3332 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003333 * \note See also our Knowledge Base article about porting to a new
3334 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003335 * 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 +00003336 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003337 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003340
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003341/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003343 *
3344 * Enable run-time version information.
3345 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003346 * Module: library/version.c
3347 *
3348 * This module provides run-time version information.
3349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003351
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003352/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003354 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003355 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003356 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003358 * Caller: library/x509_crl.c
3359 * library/x509_crt.c
3360 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003361 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003362 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003363 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3364 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003365 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3366 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003367 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003368 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003371
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003374 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003375 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003376 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003377 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003378 * Caller: library/ssl_tls.c
3379 * library/ssl*_client.c
3380 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003381 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003383 *
3384 * This module is required for X.509 certificate parsing.
3385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003387
3388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003390 *
3391 * Enable X.509 CRL parsing.
3392 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003393 * Module: library/x509_crl.c
3394 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003395 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003397 *
3398 * This module is required for X.509 CRL parsing.
3399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003401
3402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003404 *
3405 * Enable X.509 Certificate Signing Request (CSR) parsing.
3406 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003407 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003408 * Caller: library/x509_crt_write.c
3409 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 *
3412 * This module is used for reading X.509 certificate request.
3413 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003415
3416/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003418 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003419 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420 *
3421 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003422 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003423 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003424 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3425 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003426 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3427 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003428 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003429 * This module is the basis for creating X.509 certificates and CSRs.
3430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003432
3433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003435 *
3436 * Enable creating X.509 certificates.
3437 *
3438 * Module: library/x509_crt_write.c
3439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003441 *
3442 * This module is required for X.509 certificate creation.
3443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003445
3446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003449 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003450 *
3451 * Module: library/x509_csr_write.c
3452 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003454 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003455 * This module is required for X.509 certificate request writing.
3456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003458
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003459/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003460
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003461/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003462 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003463 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003464 * This section contains Mbed TLS build settings that are not associated
3465 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003466 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003467 * \{
3468 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003469
Gilles Peskinea02c1242022-03-16 17:03:19 +01003470/**
3471 * \def MBEDTLS_CONFIG_FILE
3472 *
3473 * If defined, this is a header which will be included instead of
3474 * `"mbedtls/mbedtls_config.h"`.
3475 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003476 * Unlike other configuration options, this one must be defined on the
3477 * compiler command line: a definition in `mbedtls_config.h` would have
3478 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003479 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003480 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003481 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003482 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003483 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003484 * The value of this symbol is typically a path in double quotes, either
3485 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003486 */
3487//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3488
3489/**
3490 * \def MBEDTLS_USER_CONFIG_FILE
3491 *
3492 * If defined, this is a header which will be included after
3493 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003494 * This allows you to modify the default configuration, including the ability
3495 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003496 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003497 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003498 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003499 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003500 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003501 * The value of this symbol is typically a path in double quotes, either
3502 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003503 */
3504//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3505
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003506/**
3507 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3508 *
3509 * If defined, this is a header which will be included instead of
3510 * `"psa/crypto_config.h"`.
3511 * This header file specifies which cryptographic mechanisms are available
3512 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3513 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3514 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003515 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003516 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003517 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003518 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003519 * The value of this symbol is typically a path in double quotes, either
3520 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003521 */
3522//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3523
3524/**
3525 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3526 *
3527 * If defined, this is a header which will be included after
3528 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003529 * This allows you to modify the default configuration, including the ability
3530 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003531 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003532 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003533 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003534 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003535 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003536 * The value of this symbol is typically a path in double quotes, either
3537 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003538 */
3539//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3540
Gilles Peskineb1176f22023-02-22 22:07:28 +01003541/**
3542 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3543 *
3544 * If defined, this is a header which will be included instead of
3545 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3546 * as the one in Mbed TLS, but with definitions adapted to the platform on
3547 * which the library code will run.
3548 *
3549 * \note The required content of this header can vary from one version of
3550 * Mbed TLS to the next. Integrators who provide an alternative file
3551 * should review the changes in the original file whenever they
3552 * upgrade Mbed TLS.
3553 *
3554 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3555 * non-standard feature of the C language, so this feature is only available
3556 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3557 *
3558 * The value of this symbol is typically a path in double quotes, either
3559 * absolute or relative to a directory on the include search path.
3560 */
3561//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3562
3563/**
3564 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3565 *
3566 * If defined, this is a header which will be included instead of
3567 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3568 * as the one in Mbed TLS, but with definitions adapted to the environment
3569 * in which the library code will run. The typical use for this feature
3570 * is to provide alternative type definitions on the client side in
3571 * client-server integrations of PSA crypto, where operation structures
3572 * contain handles instead of cryptographic data.
3573 *
3574 * \note The required content of this header can vary from one version of
3575 * Mbed TLS to the next. Integrators who provide an alternative file
3576 * should review the changes in the original file whenever they
3577 * upgrade Mbed TLS.
3578 *
3579 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3580 * non-standard feature of the C language, so this feature is only available
3581 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3582 *
3583 * The value of this symbol is typically a path in double quotes, either
3584 * absolute or relative to a directory on the include search path.
3585 */
3586//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3587
Gilles Peskineba4162a2022-04-11 17:04:38 +02003588/** \} name SECTION: General configuration options */
3589
3590/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003591 * \name SECTION: Module configuration options
3592 *
3593 * This section allows for the setting of module specific sizes and
3594 * configuration options. The default values are already present in the
3595 * relevant header files and should suffice for the regular use cases.
3596 *
3597 * Our advice is to enable options and change their values here
3598 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003599 * \{
3600 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003601/* The Doxygen documentation here is used when a user comments out a
3602 * setting and runs doxygen themselves. On the other hand, when we typeset
3603 * the full documentation including disabled settings, the documentation
3604 * in specific modules' header files is used if present. When editing this
3605 * file, make sure that each option is documented in exactly one place,
3606 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3607 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003608
Paul Bakker088c5c52014-04-25 11:11:10 +02003609/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003610//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003611//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003612
Paul Bakker088c5c52014-04-25 11:11:10 +02003613/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3615//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3616//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3617//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3618//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003619
Paul Bakker088c5c52014-04-25 11:11:10 +02003620/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3622//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3623//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3624//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003625
Paul Bakker088c5c52014-04-25 11:11:10 +02003626/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003627//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003629
Paul Bakker088c5c52014-04-25 11:11:10 +02003630/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003631//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3632//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003633//#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 +01003634
Paul Bakker088c5c52014-04-25 11:11:10 +02003635/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003637
Paul Bakker088c5c52014-04-25 11:11:10 +02003638/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639//#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 +02003640//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003642//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003643//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003644//#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 +02003645//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3646//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003647/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003649//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3650//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003651//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3652//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3653//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003654
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003655/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3656/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003657//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3659//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003660//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003661//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3662//#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 +02003663//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3664//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003665/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003667//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003668//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3669//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Jerry Yuf181e542023-02-23 17:16:26 +08003670//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t //#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t /**< Default milliseconds time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled. It must be signed, and at least 64 bits. If it is changed from the default, MBEDTLS_PRINTF_MS_TIME must be updated to match.*/
Jerry Yu10ce5402023-02-21 15:39:02 +08003671//#define MBEDTLS_PRINTF_MS_TIME PRId64 /**< Default fmt for printf. That's avoid compiler warning if mbedtls_ms_time_t is redefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003672
Gilles Peskine3f106f72021-09-23 17:42:39 +02003673/** \def MBEDTLS_CHECK_RETURN
3674 *
3675 * This macro is used at the beginning of the declaration of a function
3676 * to indicate that its return value should be checked. It should
3677 * instruct the compiler to emit a warning or an error if the function
3678 * is called without checking its return value.
3679 *
3680 * There is a default implementation for popular compilers in platform_util.h.
3681 * You can override the default implementation by defining your own here.
3682 *
3683 * If the implementation here is empty, this will effectively disable the
3684 * checking of functions' return values.
3685 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003686//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003687
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003688/** \def MBEDTLS_IGNORE_RETURN
3689 *
3690 * This macro requires one argument, which should be a C function call.
3691 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3692 * warning is suppressed.
3693 */
3694//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3695
Gilles Peskineed038902020-11-13 21:33:21 +01003696/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003697/**
Gilles Peskineed038902020-11-13 21:33:21 +01003698 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3699 * PSA crypto subsystem.
3700 *
3701 * If this option is unset:
3702 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003703 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003704 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3705 * on unspecified heuristics.
3706 */
3707//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3708
Steven Cooreman863470a2021-02-15 14:03:19 +01003709/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003710 * Restrict the PSA library to supporting a maximum amount of simultaneously
3711 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3712 * volatile key, or a persistent key which is loaded temporarily by the
3713 * library as part of a crypto operation in flight.
3714 *
3715 * If this option is unset, the library will fall back to a default value of
3716 * 32 keys.
3717 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003718//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003719
Paul Bakker088c5c52014-04-25 11:11:10 +02003720/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3722//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003723
Paul Bakker088c5c52014-04-25 11:11:10 +02003724/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003725
Angus Grattond8213d02016-05-25 20:56:48 +10003726/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3727 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003728 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003729 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003730 * This determines the size of the incoming TLS I/O buffer in such a way
3731 * that it is capable of holding the specified amount of plaintext data,
3732 * regardless of the protection mechanism used.
3733 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003734 * \note When using a value less than the default of 16KB on the client, it is
3735 * recommended to use the Maximum Fragment Length (MFL) extension to
3736 * inform the server about this limitation. On the server, there
3737 * is no supported, standardized way of informing the client about
3738 * restriction on the maximum size of incoming messages, and unless
3739 * the limitation has been communicated by other means, it is recommended
3740 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3741 * while keeping the default value of 16KB for the incoming buffer.
3742 *
David Horstmann95d516f2021-05-04 18:36:56 +01003743 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003744 */
3745//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3746
Gilles Peskined3d02902020-03-04 21:35:27 +01003747/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3748 *
3749 * The maximum length of CIDs used for incoming DTLS messages.
3750 *
3751 */
3752//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3753
3754/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3755 *
3756 * The maximum length of CIDs used for outgoing DTLS messages.
3757 *
3758 */
3759//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3760
TRodziewicze8dd7092021-05-12 14:19:11 +02003761/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003762 *
3763 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003764 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003765 *
3766 * The padding will always be chosen so that the length of the
3767 * padded plaintext is a multiple of the value of this option.
3768 *
3769 * Note: A value of \c 1 means that no padding will be used
3770 * for outgoing records.
3771 *
3772 * Note: On systems lacking division instructions,
3773 * a power of two should be preferred.
3774 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003775//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003776
Angus Grattond8213d02016-05-25 20:56:48 +10003777/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3778 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003779 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003780 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003781 * This determines the size of the outgoing TLS I/O buffer in such a way
3782 * that it is capable of holding the specified amount of plaintext data,
3783 * regardless of the protection mechanism used.
3784 *
Angus Grattond8213d02016-05-25 20:56:48 +10003785 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3786 * the default inward 16384 byte buffer to conform to the TLS specification.
3787 *
3788 * The minimum required outward buffer size is determined by the handshake
3789 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3790 * The specific size requirement depends on the configured ciphers and any
3791 * certificate data which is sent during the handshake.
3792 *
David Horstmann95d516f2021-05-04 18:36:56 +01003793 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003794 */
3795//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3796
Hanno Beckere0b150f2018-08-21 15:51:03 +01003797/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3798 *
3799 * Maximum number of heap-allocated bytes for the purpose of
3800 * DTLS handshake message reassembly and future message buffering.
3801 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003802 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003803 * to account for a reassembled handshake message of maximum size,
3804 * together with its reassembly bitmap.
3805 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003806 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003807 * should be sufficient for all practical situations as it allows
3808 * to reassembly a large handshake message (such as a certificate)
3809 * while buffering multiple smaller handshake messages.
3810 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003811 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003812//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003813
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003814//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 or 384 bits) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003815//#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 +02003816
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003817/**
3818 * Complete list of ciphersuites to use, in order of preference.
3819 *
3820 * \warning No dependency checking is done on that field! This option can only
3821 * be used to restrict the set of available ciphersuites. It is your
3822 * responsibility to make sure the needed modules are active.
3823 *
3824 * Use this to save a few hundred bytes of ROM (default ordering of all
3825 * available ciphersuites) and a few to a few hundred bytes of RAM.
3826 *
3827 * The value below is only an example, not the default.
3828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003829//#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 +02003830
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003831/**
3832 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3833 *
3834 * Maximum time difference in milliseconds tolerated between the age of a
3835 * ticket from the server and client point of view.
3836 * From the client point of view, the age of a ticket is the time difference
3837 * between the time when the client proposes to the server to use the ticket
3838 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3839 * the time the client received the ticket from the server.
3840 * From the server point of view, the age of a ticket is the time difference
3841 * between the time when the server receives a proposition from the client
3842 * to use the ticket and the time when the ticket was created by the server.
3843 * The server age is expected to be always greater than the client one and
3844 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3845 * maximum difference tolerated for the server to accept the ticket.
3846 * This is not used in TLS 1.2.
3847 *
3848 */
3849#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3850
3851/**
3852 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3853 *
3854 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3855 *
3856 * This must be less than 256.
3857 */
3858#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3859
3860/**
3861 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3862 *
3863 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3864 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3865 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3866 *
3867 */
3868#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3869
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003870/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003871//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003872//#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 +01003873
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003874/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003875 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003876 * mbedtls_platform_zeroize(). This replaces the default implementation in
3877 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003878 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003879 * mbedtls_platform_zeroize() is a widely used function across the library to
3880 * zero a block of memory. The implementation is expected to be secure in the
3881 * sense that it has been written to prevent the compiler from removing calls
3882 * to mbedtls_platform_zeroize() as part of redundant code elimination
3883 * optimizations. However, it is difficult to guarantee that calls to
3884 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3885 * versions of the C language standards do not provide a secure implementation
3886 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3887 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003888 * example by using directives specific to their compiler, features from newer
3889 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003890 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003891 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003892//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003893
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003894/**
3895 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003896 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003897 * platform_util.c.
3898 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003899 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003900 * library will try to use safer implementations of this function, such as
3901 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003902 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003903 * using the standard gmtime(). In this case, calls from the library to
3904 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003905 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003906 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003907 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3908 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3909 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003910 */
Hanno Becker6a739782018-09-05 15:06:19 +01003911//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003912
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003913/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003914 * Enable the verified implementations of ECDH primitives from Project Everest
3915 * (currently only Curve25519). This feature changes the layout of ECDH
3916 * contexts and therefore is a compatibility break for applications that access
3917 * fields of a mbedtls_ecdh_context structure directly. See also
3918 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003919 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003920//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003921
Aditya Deshpandee41f7e42023-01-12 16:29:02 +00003922/**
3923 * Uncomment to enable p256-m, which implements ECC key generation, ECDH,
3924 * and ECDSA for SECP256R1 curves. This driver is used as an example to
3925 * document how a third-party driver or software accelerator can be integrated
3926 * to work alongside Mbed TLS.
3927 *
3928 * \warning As of now, the built-in RNG for p256-m depends on rand(). This is
3929 * fine for examples, but not in production.
3930 * DO NOT ENABLE/USE THIS MACRO IN PRODUCTION BUILDS!
3931 */
3932//#define MBEDTLS_P256M_EXAMPLE_DRIVER_ENABLED
3933
Gilles Peskine611179c2022-04-13 23:04:48 +02003934/** \} name SECTION: Module configuration options */