blob: b043983cd504ddf94c9da3f60d335c49cf48d12b [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.
Paul Bakker15566e42011-04-24 21:19:15 +0000499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200500//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000501
502/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100503 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200504 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100505 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200506 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100507 * Uncommenting this macro omits 75% of the AES tables from
508 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
509 * by computing their values on the fly during operations
510 * (the tables are entry-wise rotations of one another).
511 *
512 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100513 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100514 * runtime. Specifically, one has to compare 4 accesses within
515 * different tables to 4 accesses with additional arithmetic
516 * operations within the same table. The performance gain/loss
517 * depends on the system and memory details.
518 *
519 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200520 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100521//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200522
523/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800524 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
525 *
526 * Use only 128-bit keys in AES operations to save ROM.
527 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800528 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800529 * or 256-bit keys.
530 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800531 * Uncommenting this macro reduces the size of AES code by ~300 bytes
532 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800533 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800534 * Module: library/aes.c
535 *
536 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800537 */
538//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
539
540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200542 *
543 * Use less ROM for the Camellia implementation (saves about 768 bytes).
544 *
545 * Uncomment this macro to use less memory for Camellia.
546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200548
549/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200550 * \def MBEDTLS_CHECK_RETURN_WARNING
551 *
552 * If this macro is defined, emit a compile-time warning if application code
553 * calls a function without checking its return value, but the return value
554 * should generally be checked in portable applications.
555 *
556 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
557 * implemented. Otherwise this option has no effect.
558 *
559 * Uncomment to get warnings on using fallible functions without checking
560 * their return value.
561 *
562 * \note This feature is a work in progress.
563 * Warnings will be added to more functions in the future.
564 *
565 * \note A few functions are considered critical, and ignoring the return
566 * value of these functions will trigger a warning even if this
567 * macro is not defined. To completely disable return value check
568 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
569 */
570//#define MBEDTLS_CHECK_RETURN_WARNING
571
572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200574 *
575 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200578
579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000581 *
582 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000585
586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000588 *
589 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000592
593/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100594 * \def MBEDTLS_CIPHER_MODE_OFB
595 *
596 * Enable Output Feedback mode (OFB) for symmetric ciphers.
597 */
598#define MBEDTLS_CIPHER_MODE_OFB
599
600/**
601 * \def MBEDTLS_CIPHER_MODE_XTS
602 *
603 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
604 */
605#define MBEDTLS_CIPHER_MODE_XTS
606
607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000609 *
610 * Enable NULL cipher.
611 * Warning: Only do so when you know what you are doing. This allows for
612 * encryption or channels without any security!
613 *
Ronald Croncee42702021-04-26 11:34:44 +0200614 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
616 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
617 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
618 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
619 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
620 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
621 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
622 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
623 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
624 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
625 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
626 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
627 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
628 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
629 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
630 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
631 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
632 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
633 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000634 *
635 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000638
639/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100640 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200641 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100642 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
643 * specific padding modes in the cipher layer with cipher modes that support
644 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200645 *
646 * If you disable all padding modes, only full blocks can be used with CBC.
647 *
648 * Enable padding modes in the cipher layer.
649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#define MBEDTLS_CIPHER_PADDING_PKCS7
651#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
652#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
653#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200654
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200655/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
656 *
657 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800658 * Without this, CTR_DRBG uses a 256-bit key
659 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200660 */
661//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
662
Paul Bakker48e93c82013-08-14 12:21:18 +0200663/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100664 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200665 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100666 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
667 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200668 *
669 * Comment macros to disable the curve and functions for it
670 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200671/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
673#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
674#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
675#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
676#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
677#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
678#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
679#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
680#define MBEDTLS_ECP_DP_BP256R1_ENABLED
681#define MBEDTLS_ECP_DP_BP384R1_ENABLED
682#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200683/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200684#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000685#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200686
687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200689 *
690 * Enable specific 'modulo p' routines for each NIST prime.
691 * Depending on the prime and architecture, makes operations 4 to 8 times
692 * faster on the corresponding curve.
693 *
694 * Comment this macro to disable NIST curves optimisation.
695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200697
698/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200699 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100700 *
701 * Enable "non-blocking" ECC operations that can return early and be resumed.
702 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200703 * This allows various functions to pause by returning
704 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
705 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
706 * order to further progress and eventually complete their operation. This is
707 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
708 * number of ECC operations a function may perform before pausing; see
709 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100710 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200711 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200712 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100713 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100714 * This option:
715 * - Adds xxx_restartable() variants of existing operations in the
716 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100717 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
718 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100719 * - ECDSA: signature generation & verification;
720 * - PK: signature generation & verification;
721 * - X509: certificate chain verification.
722 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
723 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
724 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
725 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000726 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100727 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100728 * - verification of the server's key exchange signature;
729 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100730 * - generation of the client's signature if client authentication is used,
731 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100732 *
733 * \note In the cases above, the usual SSL/TLS functions, such as
734 * mbedtls_ssl_handshake(), can now return
735 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200736 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100737 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
738 * restartable operations in PK, X.509 and TLS (see above) are not
739 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100740 * PSA, and are not restartable. These are temporary limitations that
741 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200742 *
Ron Eldor19779c42018-11-05 16:58:13 +0200743 * \note This option only works with the default software implementation of
744 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100745 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100746 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100747 * Requires: MBEDTLS_ECP_C
748 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100749 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100750 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200751//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100752
753/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100755 *
756 * Enable deterministic ECDSA (RFC 6979).
757 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
758 * may result in a compromise of the long-term signing key. This is avoided by
759 * the deterministic variant.
760 *
John Durkop36a82e52020-10-26 09:39:05 -0700761 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100762 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100763 * Comment this macro to disable deterministic ECDSA.
764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200770 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200771 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 * This enables the following ciphersuites (if other requisites are
773 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
775 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
776 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
777 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
778 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
779 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
780 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
781 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
782 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
783 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200786
787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200790 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200793 *
794 * This enables the following ciphersuites (if other requisites are
795 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
797 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
798 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
799 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
800 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
801 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
802 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
803 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
804 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
805 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100806 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100807 * \warning Using DHE constitutes a security risk as it
808 * is not possible to validate custom DH parameters.
809 * If possible, it is recommended users should consider
810 * preferring other methods of key exchange.
811 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100812 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200815
816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200818 *
819 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
820 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200821 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200822 *
823 * This enables the following ciphersuites (if other requisites are
824 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
826 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
827 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
828 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
829 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
830 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
840 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
842 * This enables the following ciphersuites (if other requisites are
843 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
845 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
846 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
847 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
848 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
849 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
850 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
851 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
852 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
853 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856
857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200860 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
863 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
865 * This enables the following ciphersuites (if other requisites are
866 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
868 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
869 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
870 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
871 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
872 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
873 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
874 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
875 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
876 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
877 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
878 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881
882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200885 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
888 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889 *
890 * This enables the following ciphersuites (if other requisites are
891 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
893 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
894 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
895 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
896 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
897 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
898 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
899 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
900 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
901 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
902 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
903 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100904 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100905 * \warning Using DHE constitutes a security risk as it
906 * is not possible to validate custom DH parameters.
907 * If possible, it is recommended users should consider
908 * preferring other methods of key exchange.
909 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100910 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913
914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200917 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200919 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
920 * MBEDTLS_RSA_C
921 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923 *
924 * This enables the following ciphersuites (if other requisites are
925 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
929 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
933 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
934 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
935 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200938
939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200942 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200943 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200944 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
945 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
946 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
952 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
954 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
957 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
958 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
959 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200962
963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 *
966 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
967 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200968 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
969 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
970 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100971 *
972 * This enables the following ciphersuites (if other requisites are
973 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
975 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
976 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
977 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
978 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
979 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
980 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
981 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
982 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
983 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100989 *
990 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
991 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200992 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
993 * MBEDTLS_RSA_C
994 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100995 *
996 * This enables the following ciphersuites (if other requisites are
997 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
999 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1000 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1001 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1002 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1003 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1004 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1005 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1006 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1007 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001010
1011/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001012 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1013 *
1014 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1015 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001016 * \warning This is currently experimental. EC J-PAKE support is based on the
1017 * Thread v1.0.0 specification; incompatible changes to the specification
1018 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001019 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001020 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001021 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001022 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1023 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001024 * \warning If SHA-256 is provided only by a PSA driver, you must call
1025 * psa_crypto_init() before the first hanshake (even if
1026 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1027 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001028 * This enables the following ciphersuites (if other requisites are
1029 * enabled as well):
1030 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1031 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001032//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001033
1034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001036 *
1037 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1038 * RFC 5915 and RFC 5480.
1039 *
1040 * Currently this means parsing the SpecifiedECDomain choice of EC
1041 * parameters (only known groups are supported, not arbitrary domains, to
1042 * avoid validation issues).
1043 *
1044 * Disable if you only need to support RFC 5915 + 5480 key formats.
1045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001047
1048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * Enable a dummy error function to make use of mbedtls_strerror() in
1052 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1053 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001054 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001055 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1056 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001057 *
1058 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001062
1063/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001065 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001066 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001067 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001071
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001072/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001074 *
1075 * Enable functions that use the filesystem.
1076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001078
1079/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001081 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001082 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001083 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001084 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001085 * application.
1086 *
1087 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001090
1091/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001092 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001093 *
1094 * Do not use built-in platform entropy functions.
1095 * This is useful if your platform does not support
1096 * standards like the /dev/urandom or Windows CryptoAPI.
1097 *
1098 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001099 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001100//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001101
1102/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001103 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001104 *
1105 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1106 * default SHA-512 based one (if both are available).
1107 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001109 *
1110 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1111 * if you have performance concerns.
1112 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113 * This option is only useful if both MBEDTLS_SHA256_C and
1114 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001117
1118/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001119 * \def MBEDTLS_ENTROPY_NV_SEED
1120 *
1121 * Enable the non-volatile (NV) seed file-based entropy source.
1122 * (Also enables the NV seed read/write functions in the platform layer)
1123 *
1124 * This is crucial (if not required) on systems that do not have a
1125 * cryptographic entropy source (in hardware or kernel) available.
1126 *
1127 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1128 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001129 * \note The read/write functions that are used by the entropy source are
1130 * determined in the platform layer, and can be modified at runtime and/or
1131 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1132 *
1133 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001134 * with regular fopen(), please make sure you make a seedfile with the
1135 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1136 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001137 * and written to or you will get an entropy source error! The default
1138 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1139 * bytes from the file.
1140 *
1141 * \note The entropy collector will write to the seed file before entropy is
1142 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001143 */
1144//#define MBEDTLS_ENTROPY_NV_SEED
1145
Ronald Cron71016a92020-08-28 19:01:50 +02001146/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001147 *
Ronald Cron71016a92020-08-28 19:01:50 +02001148 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001149 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001150 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1151 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001152 *
1153 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001154 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001155 */
Ronald Cron71016a92020-08-28 19:01:50 +02001156//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001157
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001160 *
1161 * Enable debugging of buffer allocator memory issues. Automatically prints
1162 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1163 * function for 'debug output' of allocated memory.
1164 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001165 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001166 *
1167 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001170
1171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001173 *
1174 * Include backtrace information with each allocated block.
1175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001177 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001178 *
1179 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001182
1183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001185 *
1186 * Support external private RSA keys (eg from a HSM) in the PK layer.
1187 *
1188 * Comment this macro to disable support for external private RSA keys.
1189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001190#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001191
1192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001194 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001195 * Enable support for PKCS#1 v1.5 encoding.
1196 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001197 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001198 *
Paul Bakker48377d92013-08-30 12:06:24 +02001199 * This enables support for PKCS#1 v1.5 operations.
1200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001202
1203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001205 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001206 * Enable support for PKCS#1 v2.1 encoding.
1207 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001208 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001209 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001210 * \warning If using a hash that is only provided by PSA drivers, you must
1211 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001212 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001213 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001216
Steven Cooreman6801f082021-02-19 17:21:22 +01001217/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1218 *
1219 * Enable support for platform built-in keys. If you enable this feature,
1220 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1221 * See the documentation of that function for more information.
1222 *
1223 * Built-in keys are typically derived from a hardware unique key or
1224 * stored in a secure element.
1225 *
1226 * Requires: MBEDTLS_PSA_CRYPTO_C.
1227 *
1228 * \warning This interface is experimental and may change or be removed
1229 * without notice.
1230 */
1231//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1232
Ronald Cron3768ac12021-01-26 16:58:00 +01001233/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1234 *
1235 * Enable support for PSA crypto client.
1236 *
1237 * \note This option allows to include the code necessary for a PSA
1238 * crypto client when the PSA crypto implementation is not included in
1239 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1240 * code to set and get PSA key attributes.
1241 * The development of PSA drivers partially relying on the library to
1242 * fulfill the hardware gaps is another possible usage of this option.
1243 *
1244 * \warning This interface is experimental and may change or be removed
1245 * without notice.
1246 */
1247//#define MBEDTLS_PSA_CRYPTO_CLIENT
1248
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001249/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1250 *
1251 * Make the PSA Crypto module use an external random generator provided
1252 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1253 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001254 * \note This random generator must deliver random numbers with cryptographic
1255 * quality and high performance. It must supply unpredictable numbers
1256 * with a uniform distribution. The implementation of this function
1257 * is responsible for ensuring that the random generator is seeded
1258 * with sufficient entropy. If you have a hardware TRNG which is slow
1259 * or delivers non-uniform output, declare it as an entropy source
1260 * with mbedtls_entropy_add_source() instead of enabling this option.
1261 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001262 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001263 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1264 * and define a function called mbedtls_psa_external_get_random()
1265 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001266 * ```
1267 * psa_status_t mbedtls_psa_external_get_random(
1268 * mbedtls_psa_external_random_context_t *context,
1269 * uint8_t *output, size_t output_size, size_t *output_length);
1270 * );
1271 * ```
1272 * The \c context value is initialized to 0 before the first call.
1273 * The function must fill the \c output buffer with \p output_size bytes
1274 * of random data and set \c *output_length to \p output_size.
1275 *
1276 * Requires: MBEDTLS_PSA_CRYPTO_C
1277 *
1278 * \warning If you enable this option, code that uses the PSA cryptography
1279 * interface will not use any of the entropy sources set up for
1280 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1281 * enables.
1282 *
1283 * \note This option is experimental and may be removed without notice.
1284 */
1285//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1286
Paul Bakker9dcc3222011-03-08 14:16:06 +00001287/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001288 * \def MBEDTLS_PSA_CRYPTO_SPM
1289 *
1290 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1291 * Partition Manager) integration which separates the code into two parts: a
1292 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1293 * Environment).
1294 *
1295 * Module: library/psa_crypto.c
1296 * Requires: MBEDTLS_PSA_CRYPTO_C
1297 *
1298 */
1299//#define MBEDTLS_PSA_CRYPTO_SPM
1300
1301/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001302 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001303 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001304 * Enable support for entropy injection at first boot. This feature is
1305 * required on systems that do not have a built-in entropy source (TRNG).
1306 * This feature is currently not supported on systems that have a built-in
1307 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001308 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001309 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001310 *
1311 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001312//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001313
1314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001316 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001317 * Do not use the Chinese Remainder Theorem
1318 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001319 *
1320 * Uncomment this macro to disable the use of CRT in RSA.
1321 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001324
1325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001327 *
1328 * Enable the checkup functions (*_self_test).
1329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001331
1332/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001333 * \def MBEDTLS_SHA256_SMALLER
1334 *
1335 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1336 * lower performance.
1337 *
Adam Wolf039080f2019-09-10 09:53:08 -05001338 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001339 * performance and size. This version optimizes more aggressively for size at
1340 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1341 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1342 * 30%.
1343 *
1344 * Uncomment to enable the smaller implementation of SHA256.
1345 */
1346//#define MBEDTLS_SHA256_SMALLER
1347
1348/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001349 * \def MBEDTLS_SHA512_SMALLER
1350 *
1351 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1352 * lower performance.
1353 *
1354 * Uncomment to enable the smaller implementation of SHA512.
1355 */
1356//#define MBEDTLS_SHA512_SMALLER
1357
1358/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001360 *
1361 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001362 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001363 * with other servers, only debugging of failures is harder.
1364 *
1365 * The advantage of not sending alert messages, is that no information is given
1366 * about reasons for failures thus preventing adversaries of gaining intel.
1367 *
1368 * Enable sending of all alert messages
1369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001371
1372/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001373 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1374 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001375 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001376 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001377 * in the underlying transport. The CID functionality is described
1378 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 *
1380 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001381 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1382 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1383 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001385 * The maximum lengths of outgoing and incoming CIDs can be configured
1386 * through the options
1387 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1388 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1389 *
1390 * Requires: MBEDTLS_SSL_PROTO_DTLS
1391 *
1392 * Uncomment to enable the Connection ID extension.
1393 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001394#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1395
1396
1397/**
1398 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1399 *
1400 * Defines whether RFC 9146 (default) or the legacy version
1401 * (version draft-ietf-tls-dtls-connection-id-05,
1402 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1403 * is used.
1404 *
1405 * Set the value to 0 for the standard version, and
1406 * 1 for the legacy draft version.
1407 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001408 * \deprecated Support for the legacy version of the DTLS
1409 * Connection ID feature is deprecated. Please
1410 * switch to the standardized version defined
1411 * in RFC 9146 enabled by utilizing
1412 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1413 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1414 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001415 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1416 */
1417#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001418
1419/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001420 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1421 *
1422 * Enable asynchronous external private key operations in SSL. This allows
1423 * you to configure an SSL connection to call an external cryptographic
1424 * module to perform private key operations instead of performing the
1425 * operation inside the library.
1426 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001427 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001428 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001429//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001430
1431/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001432 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1433 *
1434 * Enable serialization of the TLS context structures, through use of the
1435 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1436 *
1437 * This pair of functions allows one side of a connection to serialize the
1438 * context associated with the connection, then free or re-use that context
1439 * while the serialized state is persisted elsewhere, and finally deserialize
1440 * that state to a live context for resuming read/write operations on the
1441 * connection. From a protocol perspective, the state of the connection is
1442 * unaffected, in particular this is entirely transparent to the peer.
1443 *
1444 * Note: this is distinct from TLS session resumption, which is part of the
1445 * protocol and fully visible by the peer. TLS session resumption enables
1446 * establishing new connections associated to a saved session with shorter,
1447 * lighter handshakes, while context serialization is a local optimization in
1448 * handling a single, potentially long-lived connection.
1449 *
1450 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1451 * saved after the handshake to allow for more efficient serialization, so if
1452 * you don't need this feature you'll save RAM by disabling it.
1453 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001454 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1455 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001456 * Comment to disable the context serialization APIs.
1457 */
1458#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1459
1460/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001462 *
1463 * Enable the debug messages in SSL module for all issues.
1464 * Debug messages have been disabled in some places to prevent timing
1465 * attacks due to (unbalanced) debugging function calls.
1466 *
1467 * If you need all error reporting you should enable this during debugging,
1468 * but remove this for production servers that should log as well.
1469 *
1470 * Uncomment this macro to report all debug messages on errors introducing
1471 * a timing side-channel.
1472 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001474//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001475
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001476/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001477 *
1478 * Enable support for Encrypt-then-MAC, RFC 7366.
1479 *
1480 * This allows peers that both support it to use a more robust protection for
1481 * ciphersuites using CBC, providing deep resistance against timing attacks
1482 * on the padding or underlying cipher.
1483 *
1484 * This only affects CBC ciphersuites, and is useless if none is defined.
1485 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001486 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001487 *
1488 * Comment this macro to disable support for Encrypt-then-MAC
1489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001491
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001493 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001494 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1495 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001496 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001497 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001498 * attacks, but it is recommended to always use it (even if you disable
1499 * renegotiation), since it actually fixes a more fundamental issue in the
1500 * original SSL/TLS design, and has implications beyond Triple Handshake.
1501 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001502 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001503 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001504 * Comment this macro to disable support for Extended Master Secret.
1505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001507
Paul Bakkerd66f0702013-01-31 16:57:45 +01001508/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001509 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1510 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001511 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001512 * giving access to the peer's certificate after completion of the handshake.
1513 *
1514 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1515 * recommended to disable this option for reduced RAM usage.
1516 *
1517 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1518 * defined, but always returns \c NULL.
1519 *
1520 * \note This option has no influence on the protection against the
1521 * triple handshake attack. Even if it is disabled, Mbed TLS will
1522 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001523 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001524 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001525 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001526 *
1527 * Comment this macro to disable storing the peer's certificate
1528 * after the handshake.
1529 */
1530#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1531
1532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001534 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001535 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001536 *
1537 * The two main uses of renegotiation are (1) refresh keys on long-lived
1538 * connections and (2) client authentication after the initial handshake.
1539 * If you don't need renegotiation, it's probably better to disable it, since
1540 * it has been associated with security issues in the past and is easy to
1541 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001542 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001543 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001544 *
1545 * \note Even if this option is disabled, both client and server are aware
1546 * of the Renegotiation Indication Extension (RFC 5746) used to
1547 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1548 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1549 * configuration of this extension).
1550 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001553
1554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001556 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001557 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001558 *
1559 * Comment this macro to disable support for the max_fragment_length extension
1560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001562
1563/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001564 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1565 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001566 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001567 *
1568 * \warning This extension is currently in development and must NOT be used except
1569 * for testing purposes.
1570 *
1571 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1572 *
1573 * Uncomment this macro to enable support for the record_size_limit extension
1574 */
1575//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1576
1577/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001578 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001579 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001580 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001581 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001582 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001583 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1584 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001585 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001586 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001587 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001588 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1589 * are only provided by PSA drivers, you must call psa_crypto_init() before
1590 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001591 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001592 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001594#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001595
1596/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001597 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001598 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001599 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001600 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001601 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1602 * pre-shared keys are not supported.
1603 * See docs/architecture/tls13-support.md for a description of the TLS
1604 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001605 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001606 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001607 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001608 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001609 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1610 * directly performed by TLS 1.3 code. As a consequence, you must
1611 * call psa_crypto_init() before the first TLS 1.3 handshake.
1612 *
1613 * \note Cryptographic operations performed indirectly via another module
1614 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1615 * running handshake hash) only use PSA crypto if
1616 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001617 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001618 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001619 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001620//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001621
1622/**
Ronald Cronab65c522021-11-24 10:47:20 +01001623 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1624 *
1625 * Enable TLS 1.3 middlebox compatibility mode.
1626 *
1627 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1628 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1629 * expecting TLS 1.2 traffic.
1630 *
1631 * Turning on the compatibility mode comes at the cost of a few added bytes
1632 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1633 * that don't use it. Therefore, unless transmission bandwidth is critical and
1634 * you know that middlebox compatibility issues won't occur, it is therefore
1635 * recommended to set this option.
1636 *
1637 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001638 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1639 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001640 *
1641 */
1642//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1643
1644/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001645 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1646 *
1647 * Enable TLS 1.3 PSK key exchange mode.
1648 *
1649 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1650 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1651 * effect on the build.
1652 *
1653 */
1654#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1655
1656/**
1657 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1658 *
1659 * Enable TLS 1.3 ephemeral key exchange mode.
1660 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001661 * Requires: PSA_WANT_ALG_ECDH
1662 * MBEDTLS_X509_CRT_PARSE_C
1663 * and at least one of:
1664 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1665 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001666 *
1667 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1668 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1669 * effect on the build.
1670 *
1671 */
1672#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1673
1674/**
1675 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1676 *
1677 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1678 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001679 * Requires: PSA_WANT_ALG_ECDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001680 *
1681 * Comment to disable support for the PSK ephemeral key exchange mode in
1682 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1683 * have any effect on the build.
1684 *
1685 */
1686#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1687
1688/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 * \def MBEDTLS_SSL_EARLY_DATA
1690 *
1691 * Enable support for RFC 8446 TLS 1.3 early data.
1692 *
1693 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1694 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1695 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1696 *
1697 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1698 * is not enabled, this option does not have any effect on the build.
1699 *
1700 * This feature is experimental, not completed and thus not ready for
1701 * production.
1702 *
1703 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001704//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001705
1706/**
Jerry Yu16f68532022-11-05 10:50:06 +08001707 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1708 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001709 * The default maximum amount of 0-RTT data. See the documentation of
1710 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1711 *
1712 * It must be positive and smaller than UINT32_MAX.
1713 *
1714 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1715 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001716 *
1717 * This feature is experimental, not completed and thus not ready for
1718 * production.
1719 *
1720 */
1721#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1722
1723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001724 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001725 *
1726 * Enable support for DTLS (all available versions).
1727 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001728 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001729 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001730 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001731 *
1732 * Comment this macro to disable support for DTLS
1733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001735
1736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001737 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001738 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001739 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001740 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001741 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001744
1745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001747 *
1748 * Enable support for the anti-replay mechanism in DTLS.
1749 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750 * Requires: MBEDTLS_SSL_TLS_C
1751 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001752 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001753 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001754 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001755 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001756 * Comment this to disable anti-replay in DTLS.
1757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001759
1760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001761 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001762 *
1763 * Enable support for HelloVerifyRequest on DTLS servers.
1764 *
1765 * This feature is highly recommended to prevent DTLS servers being used as
1766 * amplifiers in DoS attacks against other hosts. It should always be enabled
1767 * unless you know for sure amplification cannot be a problem in the
1768 * environment in which your server operates.
1769 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001770 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001771 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001772 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001773 *
1774 * Comment this to disable support for HelloVerifyRequest.
1775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001776#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001777
1778/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001779 * \def MBEDTLS_SSL_DTLS_SRTP
1780 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001781 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001782 * through the use_srtp extension.
1783 *
1784 * \note This feature provides the minimum functionality required
1785 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1786 * the associated SRTP packet protection key material.
1787 * In particular, the SRTP packet protection itself, as well as the
1788 * demultiplexing of RTP and DTLS packets at the datagram layer
1789 * (see Section 5 of RFC 5764), are not handled by this feature.
1790 * Instead, after successful completion of a handshake negotiating
1791 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001792 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001793 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1794 * (this is implemented in the SSL example programs).
1795 * The resulting key should then be passed to an SRTP stack.
1796 *
1797 * Setting this option enables the runtime API
1798 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1799 * through which the supported DTLS-SRTP protection
1800 * profiles can be configured. You must call this API at
1801 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001802 *
1803 * Requires: MBEDTLS_SSL_PROTO_DTLS
1804 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001805 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001806 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001807//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001808
1809/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001810 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1811 *
1812 * Enable server-side support for clients that reconnect from the same port.
1813 *
1814 * Some clients unexpectedly close the connection and try to reconnect using the
1815 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001816 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001817 * flag enables that support.
1818 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001819 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001820 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001821 * Comment this to disable support for clients reusing the source port.
1822 */
1823#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1824
1825/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001827 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001828 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001829 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001830 * session store remains the responsibility of the application, though).
1831 * Server-side, you also need to provide callbacks for writing and parsing
1832 * tickets, including authenticated encryption and key management. Example
1833 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001834 *
1835 * Comment this macro to disable support for SSL session tickets
1836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001838
1839/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001841 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001842 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001844 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001845 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001846 * Comment this macro to disable support for server name indication in SSL
1847 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001849
1850/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001851 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1852 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001853 * When this option is enabled, the SSL buffer will be resized automatically
1854 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001855 *
1856 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001857 */
1858//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1859
1860/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001861 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1862 *
1863 * Enable testing of the constant-flow nature of some sensitive functions with
1864 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001865 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001866 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001867 * This setting requires compiling with clang -fsanitize=memory. The test
1868 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001869 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001870 * \warning This macro is only used for extended testing; it is not considered
1871 * part of the library's API, so it may change or disappear at any time.
1872 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001873 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001874 */
1875//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1876
1877/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001878 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1879 *
1880 * Enable testing of the constant-flow nature of some sensitive functions with
1881 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001882 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001883 *
1884 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001885 * testing if the tests suites are run with valgrind's memcheck. This can be
1886 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1887 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001888 *
1889 * \warning This macro is only used for extended testing; it is not considered
1890 * part of the library's API, so it may change or disappear at any time.
1891 *
1892 * Uncomment to enable testing of the constant-flow nature of selected code.
1893 */
1894//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1895
1896/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001897 * \def MBEDTLS_TEST_HOOKS
1898 *
1899 * Enable features for invasive testing such as introspection functions and
1900 * hooks for fault injection. This enables additional unit tests.
1901 *
1902 * Merely enabling this feature should not change the behavior of the product.
1903 * It only adds new code, and new branching points where the default behavior
1904 * is the same as when this feature is disabled.
1905 * However, this feature increases the attack surface: there is an added
1906 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1907 * Therefore this feature must never be enabled in production.
1908 *
1909 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1910 * information.
1911 *
1912 * Uncomment to enable invasive tests.
1913 */
1914//#define MBEDTLS_TEST_HOOKS
1915
1916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001918 *
1919 * Provide your own alternate threading implementation.
1920 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001922 *
1923 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001926
1927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001929 *
1930 * Enable the pthread wrapper layer for the threading layer.
1931 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001933 *
1934 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001936//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001937
1938/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001939 * \def MBEDTLS_USE_PSA_CRYPTO
1940 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001941 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1942 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001943 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001944 * \note Development of this option is currently in progress, and parts of Mbed
1945 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001946 * will still continue to work as usual, so enabling this option should not
1947 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001948 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001949 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001950 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1951 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001952 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001953 * \note An important and desirable effect of this option is that it allows
1954 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1955 * 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 +02001956 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001957 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1958 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001959 *
1960 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001961 *
1962 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001963 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001964 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001965 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001966//#define MBEDTLS_USE_PSA_CRYPTO
1967
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001969 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1970 *
John Durkop185764f2020-10-12 21:32:12 -07001971 * This setting allows support for cryptographic mechanisms through the PSA
1972 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001973 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001974 * When this option is disabled, the PSA API exposes the cryptographic
1975 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1976 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001977 *
1978 * When this option is enabled, the PSA API exposes the cryptographic
1979 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1980 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1981 * automatically enabled if required (i.e. if no PSA driver provides the
1982 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1983 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001984 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001985 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001986 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001987 *
John Durkop185764f2020-10-12 21:32:12 -07001988 * This feature is still experimental and is not ready for production since
1989 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001990 */
1991//#define MBEDTLS_PSA_CRYPTO_CONFIG
1992
1993/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02001994 * \def MBEDTLS_VERSION_FEATURES
1995 *
1996 * Allow run-time checking of compile-time enabled features. Thus allowing users
1997 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00001998 * support via mbedtls_version_check_feature().
1999 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002000 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002001 *
2002 * Comment this to disable run-time checking and save ROM space
2003 */
2004#define MBEDTLS_VERSION_FEATURES
2005
2006/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002007 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2008 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002009 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002010 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2011 * the set of trusted certificates through a callback instead of a linked
2012 * list.
2013 *
2014 * This is useful for example in environments where a large number of trusted
2015 * certificates is present and storing them in a linked list isn't efficient
2016 * enough, or when the set of trusted certificates changes frequently.
2017 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002018 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002019 * `mbedtls_ssl_conf_ca_cb()` for more information.
2020 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002021 * Requires: MBEDTLS_X509_CRT_PARSE_C
2022 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002023 * Uncomment to enable trusted certificate callbacks.
2024 */
2025//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2026
2027/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002028 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002029 *
Chris Jones2c745862020-12-16 11:41:06 +00002030 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002031 *
Chris Jones2c745862020-12-16 11:41:06 +00002032 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002033 * and other functions/constants only used by these functions, thus reducing
2034 * the code footprint by several KB.
2035 */
Chris Jones2c745862020-12-16 11:41:06 +00002036//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002037
2038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002040 *
2041 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2042 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2043 *
2044 * Comment this macro to disallow using RSASSA-PSS in certificates.
2045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002047/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002048
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002049/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002050 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002051 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002052 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002053 * \{
2054 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002055
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002058 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002059 * Enable AES-NI support on x86-64 or x86-32.
2060 *
2061 * \note AESNI is only supported with certain compilers and target options:
2062 * - Visual Studio 2013: supported.
2063 * - GCC, x86-64, target not explicitly supporting AESNI:
2064 * requires MBEDTLS_HAVE_ASM.
2065 * - GCC, x86-32, target not explicitly supporting AESNI:
2066 * not supported.
2067 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2068 * For this assembly-less implementation, you must currently compile
2069 * `library/aesni.c` and `library/aes.c` with machine options to enable
2070 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2071 * `clang -maes -mpclmul`.
2072 * - Non-x86 targets: this option is silently ignored.
2073 * - Other compilers: this option is silently ignored.
2074 *
2075 * \note
2076 * Above, "GCC" includes compatible compilers such as Clang.
2077 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002078 *
2079 * Module: library/aesni.c
2080 * Caller: library/aes.c
2081 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002082 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002083 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002084 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002087
2088/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002089 * \def MBEDTLS_AESCE_C
2090 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002091 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002092 *
2093 * Module: library/aesce.c
2094 * Caller: library/aes.c
2095 *
Jerry Yuf015a932023-04-25 10:38:03 +08002096 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002097 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002098 * \warning Runtime detection only works on Linux. For non-Linux operating
2099 * system, Armv8-A Cryptographic Extensions must be supported by
2100 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002101 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002102 * \note Minimum compiler versions for this feature are Clang 4.0,
2103 * GCC 6.0 or MSVC 2019 version 16.11.2.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002104 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002105 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002106 */
2107#define MBEDTLS_AESCE_C
2108
2109/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002111 *
2112 * Enable the AES block cipher.
2113 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002115 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002116 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002117 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002118 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002119 * This module enables the following ciphersuites (if other requisites are
2120 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2122 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2125 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2126 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2127 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2128 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2130 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2131 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2132 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2142 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2143 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2144 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2145 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2146 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2147 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2148 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2150 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2152 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2153 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2154 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2156 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2157 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2158 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2159 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2160 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2161 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2162 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2164 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2165 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2166 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2167 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2168 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2169 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2170 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2171 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2172 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2173 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2174 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2175 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2176 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2177 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2178 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002179 *
Paul Bakkercff68422013-09-15 20:43:33 +02002180 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002183
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002185 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002186 *
2187 * Enable the generic ASN1 parser.
2188 *
2189 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002190 * Caller: library/x509.c
2191 * library/dhm.c
2192 * library/pkcs12.c
2193 * library/pkcs5.c
2194 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002196#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002197
2198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002200 *
2201 * Enable the generic ASN1 writer.
2202 *
2203 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002204 * Caller: library/ecdsa.c
2205 * library/pkwrite.c
2206 * library/x509_create.c
2207 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002208 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002211
2212/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002214 *
2215 * Enable the Base64 module.
2216 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002217 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002218 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002219 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002220 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002223
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002224/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002226 *
Paul Bakker9a736322012-11-14 12:39:52 +00002227 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002228 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002229 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002230 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002231 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002232 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002233 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002234 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002235 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002236 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002237 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002238 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002239 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002240 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002242#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002243
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002246 *
2247 * Enable the Camellia block cipher.
2248 *
Paul Bakker38119b12009-01-10 23:31:23 +00002249 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002250 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002251 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002252 * This module enables the following ciphersuites (if other requisites are
2253 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2255 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2258 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2259 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2262 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2263 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2265 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2266 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2267 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2268 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2269 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2270 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2271 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2272 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2274 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2276 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2277 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2278 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2279 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2280 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2281 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2282 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2284 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2285 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2287 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2288 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2289 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2290 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2291 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2292 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2293 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2294 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002297#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002298
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002299/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002300 * \def MBEDTLS_ARIA_C
2301 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002302 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002303 *
2304 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002305 * Caller: library/cipher.c
2306 *
2307 * This module enables the following ciphersuites (if other requisites are
2308 * enabled as well):
2309 *
2310 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2311 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2312 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2313 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2314 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2315 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2316 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2317 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2318 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2319 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2320 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2321 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2322 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2323 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2324 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2325 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2326 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2327 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2328 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2329 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2330 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2331 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2332 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2333 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2334 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2335 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2336 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2337 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2338 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2339 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2340 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2341 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2342 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2343 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2344 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2345 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2346 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2347 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002348 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002349#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002350
2351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002352 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002353 *
2354 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2355 *
2356 * Module: library/ccm.c
2357 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002358 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2359 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002360 *
2361 * This module enables the AES-CCM ciphersuites, if other requisites are
2362 * enabled as well.
2363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002364#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002365
2366/**
Daniel King34b822c2016-05-15 17:28:08 -03002367 * \def MBEDTLS_CHACHA20_C
2368 *
2369 * Enable the ChaCha20 stream cipher.
2370 *
2371 * Module: library/chacha20.c
2372 */
2373#define MBEDTLS_CHACHA20_C
2374
2375/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002376 * \def MBEDTLS_CHACHAPOLY_C
2377 *
2378 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2379 *
2380 * Module: library/chachapoly.c
2381 *
2382 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2383 */
2384#define MBEDTLS_CHACHAPOLY_C
2385
2386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002388 *
2389 * Enable the generic cipher layer.
2390 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002391 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002392 * Caller: library/ccm.c
2393 * library/cmac.c
2394 * library/gcm.c
2395 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002396 * library/pkcs12.c
2397 * library/pkcs5.c
2398 * library/psa_crypto_aead.c
2399 * library/psa_crypto_mac.c
2400 * library/ssl_ciphersuites.c
2401 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002402 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002403 *
2404 * Uncomment to enable generic cipher wrappers.
2405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002407
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002408/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002409 * \def MBEDTLS_CMAC_C
2410 *
Simon Butcher327398a2016-10-05 14:09:11 +01002411 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2412 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002413 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002414 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2415 * implementation of the CMAC algorithm is provided by an alternate
2416 * implementation, that alternate implementation may opt to not support
2417 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2418 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002419 * Module: library/cmac.c
2420 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002421 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002422 *
2423 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002424#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002425
2426/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002427 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002428 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002429 * Enable the CTR_DRBG AES-based random generator.
2430 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002431 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002432 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002433 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2434 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002435 * \note To achieve a 256-bit security strength with CTR_DRBG,
2436 * you must use AES-256 *and* use sufficient entropy.
2437 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002438 *
2439 * Module: library/ctr_drbg.c
2440 * Caller:
2441 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002443 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002444 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002447
2448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002450 *
2451 * Enable the debug functions.
2452 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002453 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002454 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002455 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002456 * library/ssl_tls12_*.c
2457 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002458 *
2459 * This module provides debugging functions.
2460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002462
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002464 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002465 *
2466 * Enable the DES block cipher.
2467 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002468 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002469 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002470 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002471 *
Paul Bakkercff68422013-09-15 20:43:33 +02002472 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002473 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002474 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002475 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002478
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002481 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002482 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002483 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002484 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002485 * Caller: library/ssl_tls.c
2486 * library/ssl*_client.c
2487 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002488 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002489 * This module is used by the following key exchanges:
2490 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002491 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002492 * \warning Using DHE constitutes a security risk as it
2493 * is not possible to validate custom DH parameters.
2494 * If possible, it is recommended users should consider
2495 * preferring other methods of key exchange.
2496 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002497 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002500
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002503 *
2504 * Enable the elliptic curve Diffie-Hellman library.
2505 *
2506 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002507 * Caller: library/psa_crypto.c
2508 * library/ssl_tls.c
2509 * library/ssl*_client.c
2510 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002511 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002512 * This module is used by the following key exchanges:
2513 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002514 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002518
2519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002521 *
2522 * Enable the elliptic curve DSA library.
2523 *
2524 * Module: library/ecdsa.c
2525 * Caller:
2526 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002527 * This module is used by the following key exchanges:
2528 * ECDHE-ECDSA
2529 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002530 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2531 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2532 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002535
2536/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002537 * \def MBEDTLS_ECJPAKE_C
2538 *
2539 * Enable the elliptic curve J-PAKE library.
2540 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002541 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2542 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002543 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002544 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002545 * Module: library/ecjpake.c
2546 * Caller:
2547 *
2548 * This module is used by the following key exchanges:
2549 * ECJPAKE
2550 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002551 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002552 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002553 * \warning If using a hash that is only provided by PSA drivers, you must
2554 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002555 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002556#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002557
2558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560 *
2561 * Enable the elliptic curve over GF(p) library.
2562 *
2563 * Module: library/ecp.c
2564 * Caller: library/ecdh.c
2565 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002566 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002567 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002571
2572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002574 *
2575 * Enable the platform-specific entropy code.
2576 *
2577 * Module: library/entropy.c
2578 * Caller:
2579 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002581 *
2582 * This module provides a generic entropy pool
2583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002585
2586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002587 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002588 *
2589 * Enable error code to error string conversion.
2590 *
2591 * Module: library/error.c
2592 * Caller:
2593 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002594 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002597
2598/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002600 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002601 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002602 *
2603 * Module: library/gcm.c
2604 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002605 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2606 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002607 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002608 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2609 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002612
2613/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002614 * \def MBEDTLS_HKDF_C
2615 *
2616 * Enable the HKDF algorithm (RFC 5869).
2617 *
2618 * Module: library/hkdf.c
2619 * Caller:
2620 *
2621 * Requires: MBEDTLS_MD_C
2622 *
2623 * This module adds support for the Hashed Message Authentication Code
2624 * (HMAC)-based key derivation function (HKDF).
2625 */
2626#define MBEDTLS_HKDF_C
2627
2628/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002630 *
2631 * Enable the HMAC_DRBG random generator.
2632 *
2633 * Module: library/hmac_drbg.c
2634 * Caller:
2635 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002637 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002638 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002640#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002641
2642/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002643 * \def MBEDTLS_LMS_C
2644 *
2645 * Enable the LMS stateful-hash asymmetric signature algorithm.
2646 *
2647 * Module: library/lms.c
2648 * Caller:
2649 *
Raef Colesab4f8742022-09-01 12:24:31 +01002650 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002651 *
Raef Colesab4f8742022-09-01 12:24:31 +01002652 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002653 */
2654#define MBEDTLS_LMS_C
2655
2656/**
Raef Colesab4f8742022-09-01 12:24:31 +01002657 * \def MBEDTLS_LMS_PRIVATE
2658 *
2659 * Enable LMS private-key operations and signing code. Functions enabled by this
2660 * option are experimental, and should not be used in production.
2661 *
2662 * Requires: MBEDTLS_LMS_C
2663 *
2664 * Uncomment to enable the LMS signature algorithm and private key operations.
2665 */
Raef Coles5127e852022-10-07 10:35:56 +01002666//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002667
2668/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002669 * \def MBEDTLS_NIST_KW_C
2670 *
2671 * Enable the Key Wrapping mode for 128-bit block ciphers,
2672 * as defined in NIST SP 800-38F. Only KW and KWP modes
2673 * are supported. At the moment, only AES is approved by NIST.
2674 *
2675 * Module: library/nist_kw.c
2676 *
2677 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2678 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002679#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002680
2681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002683 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002684 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002685 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002686 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2687 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002688 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002689 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002690 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002691 * Caller: library/constant_time.c
2692 * library/ecdsa.c
2693 * library/ecjpake.c
2694 * library/hkdf.c
2695 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002696 * library/pk.c
2697 * library/pkcs5.c
2698 * library/pkcs12.c
2699 * library/psa_crypto_ecp.c
2700 * library/psa_crypto_rsa.c
2701 * library/rsa.c
2702 * library/ssl_cookie.c
2703 * library/ssl_msg.c
2704 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002705 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002706 * library/x509_crt.c
2707 * library/x509write_crt.c
2708 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002709 *
2710 * Uncomment to enable generic message digest wrappers.
2711 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002713
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002714/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002715 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002716 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002717 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002718 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002719 * Module: library/md5.c
2720 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002721 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002722 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002723 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002724 * This module is required for TLS 1.2 depending on the handshake parameters.
2725 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2726 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002727 *
2728 * \warning MD5 is considered a weak message digest and its use constitutes a
2729 * security risk. If possible, we recommend avoiding dependencies on
2730 * it, and considering stronger message digests instead.
2731 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002734
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002737 *
2738 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002739 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002740 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002741 *
2742 * Module: library/memory_buffer_alloc.c
2743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * Requires: MBEDTLS_PLATFORM_C
2745 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002746 *
2747 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002750
2751/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002752 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002753 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002754 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2755 *
Simon Butcherd567a232016-03-09 20:19:21 +00002756 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2757 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002758 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002760 * \note See also our Knowledge Base article about porting to a new
2761 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002762 * 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 +00002763 *
Andres AG788aa4a2016-09-14 14:32:09 +01002764 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002765 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002766 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002769
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002773 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002774 *
2775 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002776 * Caller: library/asn1write.c
2777 * library/pkcs5.c
2778 * library/pkparse.c
2779 * library/pkwrite.c
2780 * library/rsa.c
2781 * library/x509.c
2782 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002783 * library/x509_crl.c
2784 * library/x509_crt.c
2785 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002786 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002787 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002788 *
2789 * This modules translates between OIDs and internal values.
2790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002792
2793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002795 *
2796 * Enable VIA Padlock support on x86.
2797 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002798 * Module: library/padlock.c
2799 * Caller: library/aes.c
2800 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002802 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002803 * This modules adds support for the VIA PadLock on x86.
2804 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002806
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002810 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002811 *
2812 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002813 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002814 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002815 * library/x509_crl.c
2816 * library/x509_crt.c
2817 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002818 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002820 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2821 *
2822 * \warning When parsing password-protected files, if MD5 is provided only by
2823 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002824 *
Paul Bakkercff68422013-09-15 20:43:33 +02002825 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002828
2829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002831 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002832 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002833 *
2834 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002835 * Caller: library/pkwrite.c
2836 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002837 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002840 *
2841 * This modules adds support for encoding / writing PEM files.
2842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002844
2845/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002847 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002848 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002849 *
2850 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002851 * Caller: library/psa_crypto_rsa.c
2852 * library/ssl_tls.c
2853 * library/ssl*_client.c
2854 * library/ssl*_server.c
2855 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002856 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002857 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002858 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002859 * Uncomment to enable generic public key wrappers.
2860 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002862
2863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002865 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002866 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002867 *
2868 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002869 * Caller: library/x509_crt.c
2870 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002871 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002873 *
2874 * Uncomment to enable generic public key parse functions.
2875 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002877
2878/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002880 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002881 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002882 *
2883 * Module: library/pkwrite.c
2884 * Caller: library/x509write.c
2885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002887 *
2888 * Uncomment to enable generic public key write functions.
2889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002891
2892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002894 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002895 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002896 *
2897 * Module: library/pkcs5.c
2898 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002899 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002900 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002901 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002902 * \warning If using a hash that is only provided by PSA drivers, you must
2903 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002904 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002905 * This module adds support for the PKCS#5 functions.
2906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002908
2909/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002910 * \def MBEDTLS_PKCS7_C
2911 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002912 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002913 * RFC Link - https://tools.ietf.org/html/rfc2315
2914 *
2915 * Module: library/pkcs7.c
2916 *
2917 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002918 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2919 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002920 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002921 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002922 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002923#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002924
2925/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002927 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002928 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002929 * Adds algorithms for parsing PKCS#8 encrypted private keys
2930 *
2931 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002932 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002933 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002934 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2935 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2936 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002937 * \warning If using a hash that is only provided by PSA drivers, you must
2938 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002939 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002940 * This module enables PKCS#12 functions.
2941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002943
2944/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002945 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002946 *
2947 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002948 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002949 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002950 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2951 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002952 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002953 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002954 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002955 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002956 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002957 * Module: library/platform.c
2958 * Caller: Most other .c files
2959 *
2960 * This module enables abstraction of common (libc) functions.
2961 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002962#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002963
2964/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002965 * \def MBEDTLS_POLY1305_C
2966 *
2967 * Enable the Poly1305 MAC algorithm.
2968 *
2969 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002970 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002971 */
2972#define MBEDTLS_POLY1305_C
2973
2974/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002975 * \def MBEDTLS_PSA_CRYPTO_C
2976 *
2977 * Enable the Platform Security Architecture cryptography API.
2978 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002979 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002980 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002981 * Requires: MBEDTLS_CIPHER_C,
2982 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002983 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002984 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002985 *
2986 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002987#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002988
2989/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002990 * \def MBEDTLS_PSA_CRYPTO_SE_C
2991 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002992 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002993 * cryptography API.
2994 *
Ronald Crone6e6b752023-01-16 16:56:51 +01002995 * \deprecated This feature is deprecated. Please switch to the PSA driver
2996 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002997 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002998 * Module: library/psa_crypto_se.c
2999 *
3000 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3001 *
3002 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003003//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003004
3005/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003006 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3007 *
3008 * Enable the Platform Security Architecture persistent key storage.
3009 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003010 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003011 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003012 * Requires: MBEDTLS_PSA_CRYPTO_C,
3013 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3014 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003015 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003016#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003017
3018/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003019 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003020 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003021 * Enable the emulation of the Platform Security Architecture
3022 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003023 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003024 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003025 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003026 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003027 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003028#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003029
3030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003032 *
3033 * Enable the RIPEMD-160 hash algorithm.
3034 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003035 * Module: library/ripemd160.c
3036 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003037 *
3038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003039#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003040
3041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003043 *
3044 * Enable the RSA public-key cryptosystem.
3045 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003046 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003047 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003048 * Caller: library/pk.c
3049 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003051 * library/ssl*_client.c
3052 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003053 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003054 * This module is used by the following key exchanges:
3055 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003056 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003063 *
3064 * Enable the SHA1 cryptographic hash algorithm.
3065 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003066 * Module: library/sha1.c
3067 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003068 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003069 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003070 * This module is required for TLS 1.2 depending on the handshake parameters,
3071 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003072 *
3073 * \warning SHA-1 is considered a weak message digest and its use constitutes
3074 * a security risk. If possible, we recommend avoiding dependencies
3075 * on it, and considering stronger message digests instead.
3076 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003077 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003079
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003080/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003081 * \def MBEDTLS_SHA224_C
3082 *
3083 * Enable the SHA-224 cryptographic hash algorithm.
3084 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003085 * Module: library/sha256.c
3086 * Caller: library/md.c
3087 * library/ssl_cookie.c
3088 *
3089 * This module adds support for SHA-224.
3090 */
3091#define MBEDTLS_SHA224_C
3092
3093/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003094 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003095 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003096 * Enable the SHA-256 cryptographic hash algorithm.
3097 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003098 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003099 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003100 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003101 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003102 * library/ssl*_client.c
3103 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003104 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003105 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003106 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003109
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003110/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003111 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3112 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003113 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3114 * with the ARMv8 cryptographic extensions if they are available at runtime.
3115 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003116 *
3117 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3118 * for a non-Aarch64 build it will be silently ignored.
3119 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003120 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3121 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3122 *
3123 * Requires: MBEDTLS_SHA256_C.
3124 *
3125 * Module: library/sha256.c
3126 *
3127 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3128 * and use them if available.
3129 */
3130//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3131
3132/**
3133 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3134 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003135 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3136 * with the ARMv8 cryptographic extensions, which must be available at runtime
3137 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003138 *
3139 * \note This allows builds with a smaller code size than with
3140 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3141 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003142 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3143 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3144 *
3145 * Requires: MBEDTLS_SHA256_C.
3146 *
3147 * Module: library/sha256.c
3148 *
3149 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3150 * unconditionally.
3151 */
3152//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3153
3154/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003155 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003156 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003157 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003158 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003159 * Module: library/sha512.c
3160 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003161 * library/psa_crypto_hash.c
3162 * library/ssl_tls.c
3163 * library/ssl*_client.c
3164 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003165 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003166 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003167 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003168#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003169
3170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003171 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003172 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003173 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003174 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003175 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003176 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003177 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003178 * library/ssl_tls.c
3179 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003180 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003181 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003183#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003184
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003185/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003186 * \def MBEDTLS_SHA3_C
3187 *
3188 * Enable the SHA3 cryptographic hash algorithm.
3189 *
3190 * Module: library/sha3.c
3191 *
3192 * This module adds support for SHA3.
3193 */
3194#define MBEDTLS_SHA3_C
3195
3196/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003197 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3198 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003199 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3200 * with the ARMv8 cryptographic extensions if they are available at runtime.
3201 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003202 *
3203 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3204 * for a non-Aarch64 build it will be silently ignored.
3205 *
3206 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003207 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003208 *
3209 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3210 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3211 *
3212 * Requires: MBEDTLS_SHA512_C.
3213 *
3214 * Module: library/sha512.c
3215 *
3216 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3217 * and use them if available.
3218 */
3219//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3220
3221/**
3222 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3223 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003224 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3225 * with the ARMv8 cryptographic extensions, which must be available at runtime
3226 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003227 *
3228 * \note This allows builds with a smaller code size than with
3229 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3230 *
3231 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003232 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003233 *
3234 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3235 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3236 *
3237 * Requires: MBEDTLS_SHA512_C.
3238 *
3239 * Module: library/sha512.c
3240 *
3241 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3242 * unconditionally.
3243 */
3244//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3245
3246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003248 *
3249 * Enable simple SSL cache implementation.
3250 *
3251 * Module: library/ssl_cache.c
3252 * Caller:
3253 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003257
3258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003260 *
3261 * Enable basic implementation of DTLS cookies for hello verification.
3262 *
3263 * Module: library/ssl_cookie.c
3264 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003265 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003267
3268/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003269 * \def MBEDTLS_SSL_TICKET_C
3270 *
3271 * Enable an implementation of TLS server-side callbacks for session tickets.
3272 *
3273 * Module: library/ssl_ticket.c
3274 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003275 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003276 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3277 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003278 */
3279#define MBEDTLS_SSL_TICKET_C
3280
3281/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003283 *
3284 * Enable the SSL/TLS client code.
3285 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003286 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003287 * Caller:
3288 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003290 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003291 * This module is required for SSL/TLS client support.
3292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003294
Paul Bakker9a736322012-11-14 12:39:52 +00003295/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003297 *
3298 * Enable the SSL/TLS server code.
3299 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003300 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003301 * Caller:
3302 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003304 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003305 * This module is required for SSL/TLS server support.
3306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003308
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003311 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003312 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003313 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003315 * Caller: library/ssl*_client.c
3316 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003317 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3319 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003320 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003321 * This module is required for SSL/TLS.
3322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003327 *
3328 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003329 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003330 * contexts are not shared between threads. If you do intend to use contexts
3331 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003332 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003333 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003334 *
3335 * Module: library/threading.c
3336 *
3337 * This allows different threading implementations (self-implemented or
3338 * provided).
3339 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340 * You will have to enable either MBEDTLS_THREADING_ALT or
3341 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003342 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003343 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003346
3347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003350 * Enable the semi-portable timing interface.
3351 *
Simon Butcherd567a232016-03-09 20:19:21 +00003352 * \note The provided implementation only works on POSIX/Unix (including Linux,
3353 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003354 * module and provide your own implementations of the callbacks needed by
3355 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3356 * your own implementation of the whole module by setting
3357 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003358 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003359 * \note The timing module will include time.h on suitable platforms
3360 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3361 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3362 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003363 * \note See also our Knowledge Base article about porting to a new
3364 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003365 * 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 +00003366 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003367 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003370
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003371/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003373 *
3374 * Enable run-time version information.
3375 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003376 * Module: library/version.c
3377 *
3378 * This module provides run-time version information.
3379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003381
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003384 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003385 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003386 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003387 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003388 * Caller: library/x509_crl.c
3389 * library/x509_crt.c
3390 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003391 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003392 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003393 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3394 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003395 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3396 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003397 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003398 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003401
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003404 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003405 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003406 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003407 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003408 * Caller: library/ssl_tls.c
3409 * library/ssl*_client.c
3410 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003413 *
3414 * This module is required for X.509 certificate parsing.
3415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003417
3418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003420 *
3421 * Enable X.509 CRL parsing.
3422 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003423 * Module: library/x509_crl.c
3424 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003427 *
3428 * This module is required for X.509 CRL parsing.
3429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003431
3432/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003434 *
3435 * Enable X.509 Certificate Signing Request (CSR) parsing.
3436 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003437 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003438 * Caller: library/x509_crt_write.c
3439 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003440 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003441 *
3442 * This module is used for reading X.509 certificate request.
3443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003445
3446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003449 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003450 *
3451 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003452 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003453 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003454 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3455 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003456 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3457 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003458 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003459 * This module is the basis for creating X.509 certificates and CSRs.
3460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003462
3463/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003464 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003465 *
3466 * Enable creating X.509 certificates.
3467 *
3468 * Module: library/x509_crt_write.c
3469 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003471 *
3472 * This module is required for X.509 certificate creation.
3473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003475
3476/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003478 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003479 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003480 *
3481 * Module: library/x509_csr_write.c
3482 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003484 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003485 * This module is required for X.509 certificate request writing.
3486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003488
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003489/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003490
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003491/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003492 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003493 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003494 * This section contains Mbed TLS build settings that are not associated
3495 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003496 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003497 * \{
3498 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003499
Gilles Peskinea02c1242022-03-16 17:03:19 +01003500/**
3501 * \def MBEDTLS_CONFIG_FILE
3502 *
3503 * If defined, this is a header which will be included instead of
3504 * `"mbedtls/mbedtls_config.h"`.
3505 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003506 * Unlike other configuration options, this one must be defined on the
3507 * compiler command line: a definition in `mbedtls_config.h` would have
3508 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003509 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003510 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003511 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003512 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003513 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003514 * The value of this symbol is typically a path in double quotes, either
3515 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003516 */
3517//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3518
3519/**
3520 * \def MBEDTLS_USER_CONFIG_FILE
3521 *
3522 * If defined, this is a header which will be included after
3523 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003524 * This allows you to modify the default configuration, including the ability
3525 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003526 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003527 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003528 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003529 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003530 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003531 * The value of this symbol is typically a path in double quotes, either
3532 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003533 */
3534//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3535
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003536/**
3537 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3538 *
3539 * If defined, this is a header which will be included instead of
3540 * `"psa/crypto_config.h"`.
3541 * This header file specifies which cryptographic mechanisms are available
3542 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3543 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3544 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003545 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003546 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003547 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003548 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003549 * The value of this symbol is typically a path in double quotes, either
3550 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003551 */
3552//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3553
3554/**
3555 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3556 *
3557 * If defined, this is a header which will be included after
3558 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003559 * This allows you to modify the default configuration, including the ability
3560 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003561 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003562 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003563 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003564 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003565 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003566 * The value of this symbol is typically a path in double quotes, either
3567 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003568 */
3569//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3570
Gilles Peskineb1176f22023-02-22 22:07:28 +01003571/**
3572 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3573 *
3574 * If defined, this is a header which will be included instead of
3575 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3576 * as the one in Mbed TLS, but with definitions adapted to the platform on
3577 * which the library code will run.
3578 *
3579 * \note The required content of this header can vary from one version of
3580 * Mbed TLS to the next. Integrators who provide an alternative file
3581 * should review the changes in the original file whenever they
3582 * upgrade Mbed TLS.
3583 *
3584 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3585 * non-standard feature of the C language, so this feature is only available
3586 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3587 *
3588 * The value of this symbol is typically a path in double quotes, either
3589 * absolute or relative to a directory on the include search path.
3590 */
3591//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3592
3593/**
3594 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3595 *
3596 * If defined, this is a header which will be included instead of
3597 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3598 * as the one in Mbed TLS, but with definitions adapted to the environment
3599 * in which the library code will run. The typical use for this feature
3600 * is to provide alternative type definitions on the client side in
3601 * client-server integrations of PSA crypto, where operation structures
3602 * contain handles instead of cryptographic data.
3603 *
3604 * \note The required content of this header can vary from one version of
3605 * Mbed TLS to the next. Integrators who provide an alternative file
3606 * should review the changes in the original file whenever they
3607 * upgrade Mbed TLS.
3608 *
3609 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3610 * non-standard feature of the C language, so this feature is only available
3611 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3612 *
3613 * The value of this symbol is typically a path in double quotes, either
3614 * absolute or relative to a directory on the include search path.
3615 */
3616//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3617
Gilles Peskineba4162a2022-04-11 17:04:38 +02003618/** \} name SECTION: General configuration options */
3619
3620/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003621 * \name SECTION: Module configuration options
3622 *
3623 * This section allows for the setting of module specific sizes and
3624 * configuration options. The default values are already present in the
3625 * relevant header files and should suffice for the regular use cases.
3626 *
3627 * Our advice is to enable options and change their values here
3628 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003629 * \{
3630 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003631/* The Doxygen documentation here is used when a user comments out a
3632 * setting and runs doxygen themselves. On the other hand, when we typeset
3633 * the full documentation including disabled settings, the documentation
3634 * in specific modules' header files is used if present. When editing this
3635 * file, make sure that each option is documented in exactly one place,
3636 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3637 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003638
Paul Bakker088c5c52014-04-25 11:11:10 +02003639/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003640//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003642
Paul Bakker088c5c52014-04-25 11:11:10 +02003643/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3645//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3646//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3647//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3648//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003649
Paul Bakker088c5c52014-04-25 11:11:10 +02003650/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3652//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3653//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3654//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003655
Paul Bakker088c5c52014-04-25 11:11:10 +02003656/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003657//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003658//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003659
Paul Bakker088c5c52014-04-25 11:11:10 +02003660/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003661//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3662//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003663//#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 +01003664
Paul Bakker088c5c52014-04-25 11:11:10 +02003665/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003667
Paul Bakker088c5c52014-04-25 11:11:10 +02003668/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003669//#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 +02003670//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003671//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003672//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003673//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003674//#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 +02003675//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3676//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003677/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003678//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003679//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3680//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003681//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3682//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3683//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003684
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003685/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3686/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003687//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003688//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3689//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003690//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003691//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3692//#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 +02003693//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3694//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003695/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003696//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003697//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003698//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3699//#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 +08003700//#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 +08003701//#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 +02003702
Gilles Peskine3f106f72021-09-23 17:42:39 +02003703/** \def MBEDTLS_CHECK_RETURN
3704 *
3705 * This macro is used at the beginning of the declaration of a function
3706 * to indicate that its return value should be checked. It should
3707 * instruct the compiler to emit a warning or an error if the function
3708 * is called without checking its return value.
3709 *
3710 * There is a default implementation for popular compilers in platform_util.h.
3711 * You can override the default implementation by defining your own here.
3712 *
3713 * If the implementation here is empty, this will effectively disable the
3714 * checking of functions' return values.
3715 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003716//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003717
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003718/** \def MBEDTLS_IGNORE_RETURN
3719 *
3720 * This macro requires one argument, which should be a C function call.
3721 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3722 * warning is suppressed.
3723 */
3724//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3725
Gilles Peskineed038902020-11-13 21:33:21 +01003726/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003727/**
Gilles Peskineed038902020-11-13 21:33:21 +01003728 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3729 * PSA crypto subsystem.
3730 *
3731 * If this option is unset:
3732 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003733 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003734 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3735 * on unspecified heuristics.
3736 */
3737//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3738
Steven Cooreman863470a2021-02-15 14:03:19 +01003739/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003740 * Restrict the PSA library to supporting a maximum amount of simultaneously
3741 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3742 * volatile key, or a persistent key which is loaded temporarily by the
3743 * library as part of a crypto operation in flight.
3744 *
3745 * If this option is unset, the library will fall back to a default value of
3746 * 32 keys.
3747 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003748//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003749
Paul Bakker088c5c52014-04-25 11:11:10 +02003750/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003751//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3752//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003753
Paul Bakker088c5c52014-04-25 11:11:10 +02003754/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003755
Angus Grattond8213d02016-05-25 20:56:48 +10003756/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3757 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003758 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003759 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003760 * This determines the size of the incoming TLS I/O buffer in such a way
3761 * that it is capable of holding the specified amount of plaintext data,
3762 * regardless of the protection mechanism used.
3763 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003764 * \note When using a value less than the default of 16KB on the client, it is
3765 * recommended to use the Maximum Fragment Length (MFL) extension to
3766 * inform the server about this limitation. On the server, there
3767 * is no supported, standardized way of informing the client about
3768 * restriction on the maximum size of incoming messages, and unless
3769 * the limitation has been communicated by other means, it is recommended
3770 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3771 * while keeping the default value of 16KB for the incoming buffer.
3772 *
David Horstmann95d516f2021-05-04 18:36:56 +01003773 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003774 */
3775//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3776
Gilles Peskined3d02902020-03-04 21:35:27 +01003777/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3778 *
3779 * The maximum length of CIDs used for incoming DTLS messages.
3780 *
3781 */
3782//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3783
3784/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3785 *
3786 * The maximum length of CIDs used for outgoing DTLS messages.
3787 *
3788 */
3789//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3790
TRodziewicze8dd7092021-05-12 14:19:11 +02003791/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003792 *
3793 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003794 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003795 *
3796 * The padding will always be chosen so that the length of the
3797 * padded plaintext is a multiple of the value of this option.
3798 *
3799 * Note: A value of \c 1 means that no padding will be used
3800 * for outgoing records.
3801 *
3802 * Note: On systems lacking division instructions,
3803 * a power of two should be preferred.
3804 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003805//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003806
Angus Grattond8213d02016-05-25 20:56:48 +10003807/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3808 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003809 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003810 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003811 * This determines the size of the outgoing TLS I/O buffer in such a way
3812 * that it is capable of holding the specified amount of plaintext data,
3813 * regardless of the protection mechanism used.
3814 *
Angus Grattond8213d02016-05-25 20:56:48 +10003815 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3816 * the default inward 16384 byte buffer to conform to the TLS specification.
3817 *
3818 * The minimum required outward buffer size is determined by the handshake
3819 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3820 * The specific size requirement depends on the configured ciphers and any
3821 * certificate data which is sent during the handshake.
3822 *
David Horstmann95d516f2021-05-04 18:36:56 +01003823 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003824 */
3825//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3826
Hanno Beckere0b150f2018-08-21 15:51:03 +01003827/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3828 *
3829 * Maximum number of heap-allocated bytes for the purpose of
3830 * DTLS handshake message reassembly and future message buffering.
3831 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003832 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003833 * to account for a reassembled handshake message of maximum size,
3834 * together with its reassembly bitmap.
3835 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003836 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003837 * should be sufficient for all practical situations as it allows
3838 * to reassembly a large handshake message (such as a certificate)
3839 * while buffering multiple smaller handshake messages.
3840 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003841 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003842//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003843
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003844//#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 +02003845//#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 +02003846
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003847/**
3848 * Complete list of ciphersuites to use, in order of preference.
3849 *
3850 * \warning No dependency checking is done on that field! This option can only
3851 * be used to restrict the set of available ciphersuites. It is your
3852 * responsibility to make sure the needed modules are active.
3853 *
3854 * Use this to save a few hundred bytes of ROM (default ordering of all
3855 * available ciphersuites) and a few to a few hundred bytes of RAM.
3856 *
3857 * The value below is only an example, not the default.
3858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003859//#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 +02003860
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003861/**
3862 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3863 *
3864 * Maximum time difference in milliseconds tolerated between the age of a
3865 * ticket from the server and client point of view.
3866 * From the client point of view, the age of a ticket is the time difference
3867 * between the time when the client proposes to the server to use the ticket
3868 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3869 * the time the client received the ticket from the server.
3870 * From the server point of view, the age of a ticket is the time difference
3871 * between the time when the server receives a proposition from the client
3872 * to use the ticket and the time when the ticket was created by the server.
3873 * The server age is expected to be always greater than the client one and
3874 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3875 * maximum difference tolerated for the server to accept the ticket.
3876 * This is not used in TLS 1.2.
3877 *
3878 */
3879#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3880
3881/**
3882 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3883 *
3884 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3885 *
3886 * This must be less than 256.
3887 */
3888#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3889
3890/**
3891 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3892 *
3893 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3894 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3895 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3896 *
3897 */
3898#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3899
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003900/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003901//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003902//#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 +01003903
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003904/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003905 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003906 * mbedtls_platform_zeroize(). This replaces the default implementation in
3907 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003908 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003909 * mbedtls_platform_zeroize() is a widely used function across the library to
3910 * zero a block of memory. The implementation is expected to be secure in the
3911 * sense that it has been written to prevent the compiler from removing calls
3912 * to mbedtls_platform_zeroize() as part of redundant code elimination
3913 * optimizations. However, it is difficult to guarantee that calls to
3914 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3915 * versions of the C language standards do not provide a secure implementation
3916 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3917 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003918 * example by using directives specific to their compiler, features from newer
3919 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003920 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003921 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003922//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003923
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003924/**
3925 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003926 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003927 * platform_util.c.
3928 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003929 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003930 * library will try to use safer implementations of this function, such as
3931 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003932 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003933 * using the standard gmtime(). In this case, calls from the library to
3934 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003935 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003936 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003937 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3938 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3939 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003940 */
Hanno Becker6a739782018-09-05 15:06:19 +01003941//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003942
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003943/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003944 * Enable the verified implementations of ECDH primitives from Project Everest
3945 * (currently only Curve25519). This feature changes the layout of ECDH
3946 * contexts and therefore is a compatibility break for applications that access
3947 * fields of a mbedtls_ecdh_context structure directly. See also
3948 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003949 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003950//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003951
Aditya Deshpandee41f7e42023-01-12 16:29:02 +00003952/**
3953 * Uncomment to enable p256-m, which implements ECC key generation, ECDH,
3954 * and ECDSA for SECP256R1 curves. This driver is used as an example to
3955 * document how a third-party driver or software accelerator can be integrated
3956 * to work alongside Mbed TLS.
3957 *
Aditya Deshpandebac592d2023-02-14 14:55:49 +00003958 * \warning p256-m has only been included to serve as a sample implementation
3959 * of how a driver/accelerator can be integrated alongside Mbed TLS. It is not
Aditya Deshpandef100f002023-03-21 14:49:31 +00003960 * intended for use in production. p256-m files in Mbed TLS are not updated
3961 * regularly, so they may not contain upstream fixes/improvements.
Aditya Deshpandee41f7e42023-01-12 16:29:02 +00003962 * DO NOT ENABLE/USE THIS MACRO IN PRODUCTION BUILDS!
3963 */
3964//#define MBEDTLS_P256M_EXAMPLE_DRIVER_ENABLED
3965
Gilles Peskine611179c2022-04-13 23:04:48 +02003966/** \} name SECTION: Module configuration options */