blob: 0ad6dccb9951b2ae2638ce02a2269216364c8a4f [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
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100241
242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100244 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000245 * Mark deprecated functions and features so that they generate a warning if
246 * used. Functionality deprecated in one version will usually be removed in the
247 * next version. You can enable this to help you prepare the transition to a
248 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100249 *
250 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100252 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000253 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100256
257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100259 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000260 * Remove deprecated functions and features so that they generate an error if
261 * used. Functionality deprecated in one version will usually be removed in the
262 * next version. You can enable this to help you prepare the transition to a
263 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100264 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000265 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100268
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100269/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000270
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000271/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000272 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000273 *
274 * This section sets support for features that are or are not needed
275 * within the modules that are enabled.
276 * \{
277 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000278
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100281 *
TRodziewiczd8540832021-06-10 15:16:50 +0200282 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200283 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100284 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100286 *
287 * You will need to provide a header "timing_alt.h" and an implementation at
288 * compile time.
289 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100291
292/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100293 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200294 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100295 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100296 * alternate core implementation of a symmetric crypto, an arithmetic or hash
297 * module (e.g. platform specific assembly optimized implementations). Keep
298 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200299 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200300 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200302 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000304 * provide the "struct mbedtls_aes_context" definition and omit the base
305 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200306 * "aes.h" to include the new function definitions.
307 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200308 * Uncomment a macro to enable alternate implementation of the corresponding
309 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100310 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200311 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100312 * use constitutes a security risk. If possible, we recommend
313 * avoiding dependencies on them, and considering stronger message
314 * digests and ciphers instead.
315 *
Paul Bakker90995b52013-06-24 19:20:35 +0200316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200317//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000318//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200320//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300321//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200322//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200323//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000325//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000326//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100327//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300328//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300330//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200331//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000332//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200333//#define MBEDTLS_SHA1_ALT
334//#define MBEDTLS_SHA256_ALT
335//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000336
Janos Follathb0697532016-08-18 12:38:46 +0100337/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800338 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100339 * implemented with two .c files:
340 * - ecp.c
341 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000342 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
343 * macros as described above. The only difference is that you have to make sure
344 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100345 */
346//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200347
348/**
TRodziewicz75628d52021-06-18 12:56:27 +0200349 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200350 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100351 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
352 * alternate core implementation of symmetric crypto or hash function. Keep in
353 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200354 *
355 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
359 * no longer provide the mbedtls_sha1_process() function, but it will still provide
360 * the other function (using your mbedtls_sha1_process() function) and the definition
361 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200362 * with this definition.
363 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200364 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100365 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
366 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200367 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200368 * Uncomment a macro to enable alternate implementation of the corresponding
369 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100370 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200371 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100372 * constitutes a security risk. If possible, we recommend avoiding
373 * dependencies on them, and considering stronger message digests
374 * and ciphers instead.
375 *
Janos Follath1231d212019-01-07 15:01:32 +0000376 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
377 * enabled, then the deterministic ECDH signature functions pass the
378 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
379 * alternative implementations should use the RNG only for generating
380 * the ephemeral key and nothing else. If this is not possible, then
381 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200382 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000383 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385//#define MBEDTLS_MD5_PROCESS_ALT
386//#define MBEDTLS_RIPEMD160_PROCESS_ALT
387//#define MBEDTLS_SHA1_PROCESS_ALT
388//#define MBEDTLS_SHA256_PROCESS_ALT
389//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200390//#define MBEDTLS_DES_SETKEY_ALT
391//#define MBEDTLS_DES_CRYPT_ECB_ALT
392//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200393//#define MBEDTLS_AES_SETKEY_ENC_ALT
394//#define MBEDTLS_AES_SETKEY_DEC_ALT
395//#define MBEDTLS_AES_ENCRYPT_ALT
396//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300397//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300398//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300399//#define MBEDTLS_ECDSA_VERIFY_ALT
400//#define MBEDTLS_ECDSA_SIGN_ALT
401//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200402
403/**
Janos Follathc44ab972016-11-18 16:38:23 +0000404 * \def MBEDTLS_ECP_INTERNAL_ALT
405 *
406 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100407 *
408 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100409 * alternative core implementation of elliptic curve arithmetic. Keep in mind
410 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100411 *
412 * This partially replaces one function. The header file from mbed TLS is still
413 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
414 * is still present and it is used for group structures not supported by the
415 * alternative.
416 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100417 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100418 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100419 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
420 * able to fallback to curves not supported by the alternative implementation.
421 *
Janos Follathc44ab972016-11-18 16:38:23 +0000422 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
423 * and implementing the following functions:
424 * unsigned char mbedtls_internal_ecp_grp_capable(
425 * const mbedtls_ecp_group *grp )
426 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500427 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000428 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
429 * replacement functions implement arithmetic for the given group and 0
430 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500431 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000432 * called before and after each point operation and provide an opportunity to
433 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100434 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100435 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
436 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
437 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
438 * for the operation is supported by your implementation (i.e. your
439 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
440 * group is not supported by your implementation, then the original mbed TLS
441 * implementation of ecp_double_jac() is used instead, unless this fallback
442 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
443 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
444 *
445 * The function prototypes and the definition of mbedtls_ecp_group and
446 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
447 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
448 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100449 *
450 * Uncomment a macro to enable alternate implementation of the corresponding
451 * function.
452 */
453/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000454//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100455/* Turn off software fallback for curves not supported in hardware */
456//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100457/* Support for Weierstrass curves with Jacobi representation */
458//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
459//#define MBEDTLS_ECP_ADD_MIXED_ALT
460//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
461//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
462//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
463/* Support for curves with Montgomery arithmetic */
464//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
465//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
466//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
467
468/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200469 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200470 *
471 * Uncomment this macro to let mbed TLS use your own implementation of a
472 * hardware entropy collector.
473 *
474 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000475 * prototype as declared in library/entropy_poll.h, and accept NULL as first
476 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200477 *
478 * Uncomment to use your own hardware entropy collector.
479 */
480//#define MBEDTLS_ENTROPY_HARDWARE_ALT
481
482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000484 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100485 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000486 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100487 * Uncomment this macro to use precomputed AES tables stored in ROM.
488 * Comment this macro to generate AES tables in RAM at runtime.
489 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100490 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
491 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100492 * initialization time before the first AES operation can be performed.
493 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
494 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
495 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100496 *
497 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
498 *
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.
520 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200521 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100522//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200523
524/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200526 *
527 * Use less ROM for the Camellia implementation (saves about 768 bytes).
528 *
529 * Uncomment this macro to use less memory for Camellia.
530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200532
533/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200534 * \def MBEDTLS_CHECK_RETURN_WARNING
535 *
536 * If this macro is defined, emit a compile-time warning if application code
537 * calls a function without checking its return value, but the return value
538 * should generally be checked in portable applications.
539 *
540 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
541 * implemented. Otherwise this option has no effect.
542 *
543 * Uncomment to get warnings on using fallible functions without checking
544 * their return value.
545 *
546 * \note This feature is a work in progress.
547 * Warnings will be added to more functions in the future.
548 *
549 * \note A few functions are considered critical, and ignoring the return
550 * value of these functions will trigger a warning even if this
551 * macro is not defined. To completely disable return value check
552 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
553 */
554//#define MBEDTLS_CHECK_RETURN_WARNING
555
556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200558 *
559 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
560 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200562
563/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000565 *
566 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000569
570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000572 *
573 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
574 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000576
577/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100578 * \def MBEDTLS_CIPHER_MODE_OFB
579 *
580 * Enable Output Feedback mode (OFB) for symmetric ciphers.
581 */
582#define MBEDTLS_CIPHER_MODE_OFB
583
584/**
585 * \def MBEDTLS_CIPHER_MODE_XTS
586 *
587 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
588 */
589#define MBEDTLS_CIPHER_MODE_XTS
590
591/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200592 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000593 *
594 * Enable NULL cipher.
595 * Warning: Only do so when you know what you are doing. This allows for
596 * encryption or channels without any security!
597 *
Ronald Croncee42702021-04-26 11:34:44 +0200598 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
600 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
601 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
602 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
603 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
604 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
605 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
606 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
607 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
608 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
609 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
610 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
611 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
612 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
613 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
614 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
615 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
616 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
617 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000618 *
619 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000622
623/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100624 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200625 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100626 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
627 * specific padding modes in the cipher layer with cipher modes that support
628 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200629 *
630 * If you disable all padding modes, only full blocks can be used with CBC.
631 *
632 * Enable padding modes in the cipher layer.
633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200634#define MBEDTLS_CIPHER_PADDING_PKCS7
635#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
636#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
637#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200638
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200639/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
640 *
641 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
642 * By default, CTR_DRBG uses a 256-bit key.
643 */
644//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
645
Paul Bakker48e93c82013-08-14 12:21:18 +0200646/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100647 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200648 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100649 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
650 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200651 *
652 * Comment macros to disable the curve and functions for it
653 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200654/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200655#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
656#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
657#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
658#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
659#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
660#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
661#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
662#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
663#define MBEDTLS_ECP_DP_BP256R1_ENABLED
664#define MBEDTLS_ECP_DP_BP384R1_ENABLED
665#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200666/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200667#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000668#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200669
670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200672 *
673 * Enable specific 'modulo p' routines for each NIST prime.
674 * Depending on the prime and architecture, makes operations 4 to 8 times
675 * faster on the corresponding curve.
676 *
677 * Comment this macro to disable NIST curves optimisation.
678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200679#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200680
681/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200682 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100683 *
684 * Enable "non-blocking" ECC operations that can return early and be resumed.
685 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200686 * This allows various functions to pause by returning
687 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
688 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
689 * order to further progress and eventually complete their operation. This is
690 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
691 * number of ECC operations a function may perform before pausing; see
692 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100693 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200694 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200695 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100696 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100697 * This option:
698 * - Adds xxx_restartable() variants of existing operations in the
699 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100700 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
701 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100702 * - ECDSA: signature generation & verification;
703 * - PK: signature generation & verification;
704 * - X509: certificate chain verification.
705 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
706 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
707 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
708 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000709 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100710 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100711 * - verification of the server's key exchange signature;
712 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100713 * - generation of the client's signature if client authentication is used,
714 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100715 *
716 * \note In the cases above, the usual SSL/TLS functions, such as
717 * mbedtls_ssl_handshake(), can now return
718 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200719 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100720 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
721 * restartable operations in PK, X.509 and TLS (see above) are not
722 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100723 * PSA, and are not restartable. These are temporary limitations that
724 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200725 *
Ron Eldor19779c42018-11-05 16:58:13 +0200726 * \note This option only works with the default software implementation of
727 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100728 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100729 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100730 * Requires: MBEDTLS_ECP_C
731 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100732 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100733 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200734//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100735
736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100738 *
739 * Enable deterministic ECDSA (RFC 6979).
740 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
741 * may result in a compromise of the long-term signing key. This is avoided by
742 * the deterministic variant.
743 *
John Durkop36a82e52020-10-26 09:39:05 -0700744 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100745 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100746 * Comment this macro to disable deterministic ECDSA.
747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200748#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100749
750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200752 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200753 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200754 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200755 * This enables the following ciphersuites (if other requisites are
756 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
759 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
762 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
763 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
764 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
765 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
766 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200767 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200769
770/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200773 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200774 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200776 *
777 * This enables the following ciphersuites (if other requisites are
778 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
784 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
785 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
786 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
787 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
788 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100789 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100790 * \warning Using DHE constitutes a security risk as it
791 * is not possible to validate custom DH parameters.
792 * If possible, it is recommended users should consider
793 * preferring other methods of key exchange.
794 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100795 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200798
799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 *
802 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
803 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200804 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200805 *
806 * This enables the following ciphersuites (if other requisites are
807 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
810 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
811 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
812 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
813 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200816
817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200819 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200820 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200821 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200822 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
823 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200824 *
825 * This enables the following ciphersuites (if other requisites are
826 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
832 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
833 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
834 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
835 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
836 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200839
840/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200842 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200843 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200844 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
846 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200847 *
848 * This enables the following ciphersuites (if other requisites are
849 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
851 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
852 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
856 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
857 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
858 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
859 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
860 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
861 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200862 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864
865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200868 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
871 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200872 *
873 * This enables the following ciphersuites (if other requisites are
874 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
881 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
883 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
884 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
885 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
886 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100887 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100888 * \warning Using DHE constitutes a security risk as it
889 * is not possible to validate custom DH parameters.
890 * If possible, it is recommended users should consider
891 * preferring other methods of key exchange.
892 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100893 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200896
897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200899 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200900 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200901 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200902 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
903 * MBEDTLS_RSA_C
904 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 *
907 * This enables the following ciphersuites (if other requisites are
908 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
918 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200920#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200921
922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200924 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200925 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200927 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
928 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
929 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200930 *
931 * This enables the following ciphersuites (if other requisites are
932 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
939 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
941 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
942 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200943 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200944#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200945
946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 *
949 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
950 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200951 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
952 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
953 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100954 *
955 * This enables the following ciphersuites (if other requisites are
956 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
961 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
962 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
963 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
964 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
965 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
966 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100969
970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100972 *
973 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
974 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200975 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
976 * MBEDTLS_RSA_C
977 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100978 *
979 * This enables the following ciphersuites (if other requisites are
980 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
982 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
983 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
984 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
985 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
986 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
987 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
988 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
989 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
990 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100991 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200992#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100993
994/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200995 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
996 *
997 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
998 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200999 * \warning This is currently experimental. EC J-PAKE support is based on the
1000 * Thread v1.0.0 specification; incompatible changes to the specification
1001 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001002 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001003 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001004 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001005 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1006 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001007 * \warning If SHA-256 is provided only by a PSA driver, you must call
1008 * psa_crypto_init() before the first hanshake (even if
1009 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1010 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001011 * This enables the following ciphersuites (if other requisites are
1012 * enabled as well):
1013 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1014 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001015//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001016
1017/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001019 *
1020 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1021 * RFC 5915 and RFC 5480.
1022 *
1023 * Currently this means parsing the SpecifiedECDomain choice of EC
1024 * parameters (only known groups are supported, not arbitrary domains, to
1025 * avoid validation issues).
1026 *
1027 * Disable if you only need to support RFC 5915 + 5480 key formats.
1028 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001030
1031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * Enable a dummy error function to make use of mbedtls_strerror() in
1035 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1036 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001037 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1039 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001040 *
1041 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001048 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001049 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001054
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001057 *
1058 * Enable functions that use the filesystem.
1059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001061
1062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001064 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001065 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001066 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001067 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001068 * application.
1069 *
1070 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001071 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001073
1074/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001076 *
1077 * Do not use built-in platform entropy functions.
1078 * This is useful if your platform does not support
1079 * standards like the /dev/urandom or Windows CryptoAPI.
1080 *
1081 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001084
1085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001087 *
1088 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1089 * default SHA-512 based one (if both are available).
1090 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001092 *
1093 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1094 * if you have performance concerns.
1095 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001096 * This option is only useful if both MBEDTLS_SHA256_C and
1097 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001098 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001099//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001100
1101/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001102 * \def MBEDTLS_ENTROPY_NV_SEED
1103 *
1104 * Enable the non-volatile (NV) seed file-based entropy source.
1105 * (Also enables the NV seed read/write functions in the platform layer)
1106 *
1107 * This is crucial (if not required) on systems that do not have a
1108 * cryptographic entropy source (in hardware or kernel) available.
1109 *
1110 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1111 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001112 * \note The read/write functions that are used by the entropy source are
1113 * determined in the platform layer, and can be modified at runtime and/or
1114 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1115 *
1116 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001117 * with regular fopen(), please make sure you make a seedfile with the
1118 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1119 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001120 * and written to or you will get an entropy source error! The default
1121 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1122 * bytes from the file.
1123 *
1124 * \note The entropy collector will write to the seed file before entropy is
1125 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001126 */
1127//#define MBEDTLS_ENTROPY_NV_SEED
1128
Ronald Cron71016a92020-08-28 19:01:50 +02001129/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001130 *
Ronald Cron71016a92020-08-28 19:01:50 +02001131 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001132 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001133 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1134 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001135 *
1136 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001137 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001138 */
Ronald Cron71016a92020-08-28 19:01:50 +02001139//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001140
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001143 *
1144 * Enable debugging of buffer allocator memory issues. Automatically prints
1145 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1146 * function for 'debug output' of allocated memory.
1147 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001149 *
1150 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001156 *
1157 * Include backtrace information with each allocated block.
1158 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001160 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001161 *
1162 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001165
1166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001167 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001168 *
1169 * Support external private RSA keys (eg from a HSM) in the PK layer.
1170 *
1171 * Comment this macro to disable support for external private RSA keys.
1172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001174
1175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001177 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001178 * Enable support for PKCS#1 v1.5 encoding.
1179 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001180 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001181 *
Paul Bakker48377d92013-08-30 12:06:24 +02001182 * This enables support for PKCS#1 v1.5 operations.
1183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001185
1186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001188 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001189 * Enable support for PKCS#1 v2.1 encoding.
1190 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001191 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001192 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001193 * \warning If using a hash that is only provided by PSA drivers, you must
1194 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001195 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001196 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001199
Steven Cooreman6801f082021-02-19 17:21:22 +01001200/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1201 *
1202 * Enable support for platform built-in keys. If you enable this feature,
1203 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1204 * See the documentation of that function for more information.
1205 *
1206 * Built-in keys are typically derived from a hardware unique key or
1207 * stored in a secure element.
1208 *
1209 * Requires: MBEDTLS_PSA_CRYPTO_C.
1210 *
1211 * \warning This interface is experimental and may change or be removed
1212 * without notice.
1213 */
1214//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1215
Ronald Cron3768ac12021-01-26 16:58:00 +01001216/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1217 *
1218 * Enable support for PSA crypto client.
1219 *
1220 * \note This option allows to include the code necessary for a PSA
1221 * crypto client when the PSA crypto implementation is not included in
1222 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1223 * code to set and get PSA key attributes.
1224 * The development of PSA drivers partially relying on the library to
1225 * fulfill the hardware gaps is another possible usage of this option.
1226 *
1227 * \warning This interface is experimental and may change or be removed
1228 * without notice.
1229 */
1230//#define MBEDTLS_PSA_CRYPTO_CLIENT
1231
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001232/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1233 *
1234 * Enable support for the experimental PSA crypto driver interface.
1235 *
John Durkop185764f2020-10-12 21:32:12 -07001236 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001237 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001238 * \warning This interface is experimental. We intend to maintain backward
1239 * compatibility with application code that relies on drivers,
1240 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001241 */
1242//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1243
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001244/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1245 *
1246 * Make the PSA Crypto module use an external random generator provided
1247 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1248 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001249 * \note This random generator must deliver random numbers with cryptographic
1250 * quality and high performance. It must supply unpredictable numbers
1251 * with a uniform distribution. The implementation of this function
1252 * is responsible for ensuring that the random generator is seeded
1253 * with sufficient entropy. If you have a hardware TRNG which is slow
1254 * or delivers non-uniform output, declare it as an entropy source
1255 * with mbedtls_entropy_add_source() instead of enabling this option.
1256 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001257 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001258 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1259 * and define a function called mbedtls_psa_external_get_random()
1260 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001261 * ```
1262 * psa_status_t mbedtls_psa_external_get_random(
1263 * mbedtls_psa_external_random_context_t *context,
1264 * uint8_t *output, size_t output_size, size_t *output_length);
1265 * );
1266 * ```
1267 * The \c context value is initialized to 0 before the first call.
1268 * The function must fill the \c output buffer with \p output_size bytes
1269 * of random data and set \c *output_length to \p output_size.
1270 *
1271 * Requires: MBEDTLS_PSA_CRYPTO_C
1272 *
1273 * \warning If you enable this option, code that uses the PSA cryptography
1274 * interface will not use any of the entropy sources set up for
1275 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1276 * enables.
1277 *
1278 * \note This option is experimental and may be removed without notice.
1279 */
1280//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1281
Paul Bakker9dcc3222011-03-08 14:16:06 +00001282/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001283 * \def MBEDTLS_PSA_CRYPTO_SPM
1284 *
1285 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1286 * Partition Manager) integration which separates the code into two parts: a
1287 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1288 * Environment).
1289 *
1290 * Module: library/psa_crypto.c
1291 * Requires: MBEDTLS_PSA_CRYPTO_C
1292 *
1293 */
1294//#define MBEDTLS_PSA_CRYPTO_SPM
1295
1296/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001297 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001298 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001299 * Enable support for entropy injection at first boot. This feature is
1300 * required on systems that do not have a built-in entropy source (TRNG).
1301 * This feature is currently not supported on systems that have a built-in
1302 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001303 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001304 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001305 *
1306 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001307//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001308
1309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001311 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001312 * Do not use the Chinese Remainder Theorem
1313 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001314 *
1315 * Uncomment this macro to disable the use of CRT in RSA.
1316 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001319
1320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001322 *
1323 * Enable the checkup functions (*_self_test).
1324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001325#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001326
1327/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001328 * \def MBEDTLS_SHA256_SMALLER
1329 *
1330 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1331 * lower performance.
1332 *
Adam Wolf039080f2019-09-10 09:53:08 -05001333 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001334 * performance and size. This version optimizes more aggressively for size at
1335 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1336 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1337 * 30%.
1338 *
1339 * Uncomment to enable the smaller implementation of SHA256.
1340 */
1341//#define MBEDTLS_SHA256_SMALLER
1342
1343/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001344 * \def MBEDTLS_SHA512_SMALLER
1345 *
1346 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1347 * lower performance.
1348 *
1349 * Uncomment to enable the smaller implementation of SHA512.
1350 */
1351//#define MBEDTLS_SHA512_SMALLER
1352
1353/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001355 *
1356 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001357 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001358 * with other servers, only debugging of failures is harder.
1359 *
1360 * The advantage of not sending alert messages, is that no information is given
1361 * about reasons for failures thus preventing adversaries of gaining intel.
1362 *
1363 * Enable sending of all alert messages
1364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001365#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001366
1367/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001368 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1369 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001370 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001371 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001372 * in the underlying transport. The CID functionality is described
1373 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001374 *
1375 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001376 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1377 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1378 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001380 * The maximum lengths of outgoing and incoming CIDs can be configured
1381 * through the options
1382 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1383 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1384 *
1385 * Requires: MBEDTLS_SSL_PROTO_DTLS
1386 *
1387 * Uncomment to enable the Connection ID extension.
1388 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001389#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1390
1391
1392/**
1393 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1394 *
1395 * Defines whether RFC 9146 (default) or the legacy version
1396 * (version draft-ietf-tls-dtls-connection-id-05,
1397 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1398 * is used.
1399 *
1400 * Set the value to 0 for the standard version, and
1401 * 1 for the legacy draft version.
1402 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001403 * \deprecated Support for the legacy version of the DTLS
1404 * Connection ID feature is deprecated. Please
1405 * switch to the standardized version defined
1406 * in RFC 9146 enabled by utilizing
1407 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1408 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1409 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001410 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1411 */
1412#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001413
1414/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001415 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1416 *
1417 * Enable asynchronous external private key operations in SSL. This allows
1418 * you to configure an SSL connection to call an external cryptographic
1419 * module to perform private key operations instead of performing the
1420 * operation inside the library.
1421 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001422 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001423 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001424//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001425
1426/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001427 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1428 *
1429 * Enable serialization of the TLS context structures, through use of the
1430 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1431 *
1432 * This pair of functions allows one side of a connection to serialize the
1433 * context associated with the connection, then free or re-use that context
1434 * while the serialized state is persisted elsewhere, and finally deserialize
1435 * that state to a live context for resuming read/write operations on the
1436 * connection. From a protocol perspective, the state of the connection is
1437 * unaffected, in particular this is entirely transparent to the peer.
1438 *
1439 * Note: this is distinct from TLS session resumption, which is part of the
1440 * protocol and fully visible by the peer. TLS session resumption enables
1441 * establishing new connections associated to a saved session with shorter,
1442 * lighter handshakes, while context serialization is a local optimization in
1443 * handling a single, potentially long-lived connection.
1444 *
1445 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1446 * saved after the handshake to allow for more efficient serialization, so if
1447 * you don't need this feature you'll save RAM by disabling it.
1448 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001449 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1450 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001451 * Comment to disable the context serialization APIs.
1452 */
1453#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1454
1455/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001457 *
1458 * Enable the debug messages in SSL module for all issues.
1459 * Debug messages have been disabled in some places to prevent timing
1460 * attacks due to (unbalanced) debugging function calls.
1461 *
1462 * If you need all error reporting you should enable this during debugging,
1463 * but remove this for production servers that should log as well.
1464 *
1465 * Uncomment this macro to report all debug messages on errors introducing
1466 * a timing side-channel.
1467 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001470
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001472 *
1473 * Enable support for Encrypt-then-MAC, RFC 7366.
1474 *
1475 * This allows peers that both support it to use a more robust protection for
1476 * ciphersuites using CBC, providing deep resistance against timing attacks
1477 * on the padding or underlying cipher.
1478 *
1479 * This only affects CBC ciphersuites, and is useless if none is defined.
1480 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001481 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001482 *
1483 * Comment this macro to disable support for Encrypt-then-MAC
1484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001486
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001488 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001489 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1490 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001491 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001492 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001493 * attacks, but it is recommended to always use it (even if you disable
1494 * renegotiation), since it actually fixes a more fundamental issue in the
1495 * original SSL/TLS design, and has implications beyond Triple Handshake.
1496 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001497 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001498 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001499 * Comment this macro to disable support for Extended Master Secret.
1500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001501#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001502
Paul Bakkerd66f0702013-01-31 16:57:45 +01001503/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001504 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1505 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001506 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001507 * giving access to the peer's certificate after completion of the handshake.
1508 *
1509 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1510 * recommended to disable this option for reduced RAM usage.
1511 *
1512 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1513 * defined, but always returns \c NULL.
1514 *
1515 * \note This option has no influence on the protection against the
1516 * triple handshake attack. Even if it is disabled, Mbed TLS will
1517 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001518 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001519 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001520 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1521 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001522 * Comment this macro to disable storing the peer's certificate
1523 * after the handshake.
1524 */
1525#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1526
1527/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001529 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001530 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001531 *
1532 * The two main uses of renegotiation are (1) refresh keys on long-lived
1533 * connections and (2) client authentication after the initial handshake.
1534 * If you don't need renegotiation, it's probably better to disable it, since
1535 * it has been associated with security issues in the past and is easy to
1536 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001537 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001538 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001539 *
1540 * \note Even if this option is disabled, both client and server are aware
1541 * of the Renegotiation Indication Extension (RFC 5746) used to
1542 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1543 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1544 * configuration of this extension).
1545 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001548
1549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001551 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001552 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001553 *
1554 * Comment this macro to disable support for the max_fragment_length extension
1555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001557
1558/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001559 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1560 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001561 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001562 *
1563 * \warning This extension is currently in development and must NOT be used except
1564 * for testing purposes.
1565 *
1566 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1567 *
1568 * Uncomment this macro to enable support for the record_size_limit extension
1569 */
1570//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1571
1572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001574 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001575 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001576 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001577 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001578 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1579 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001580 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001581 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001582 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001583 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1584 * are only provided by PSA drivers, you must call psa_crypto_init() before
1585 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001586 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001587 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001590
1591/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001592 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001593 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001594 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001595 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001596 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1597 * pre-shared keys are not supported.
1598 * See docs/architecture/tls13-support.md for a description of the TLS
1599 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001600 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001601 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001602 * Requires: MBEDTLS_PSA_CRYPTO_C
1603 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001604 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1605 * directly performed by TLS 1.3 code. As a consequence, you must
1606 * call psa_crypto_init() before the first TLS 1.3 handshake.
1607 *
1608 * \note Cryptographic operations performed indirectly via another module
1609 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1610 * running handshake hash) only use PSA crypto if
1611 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001612 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001613 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001614 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001615//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001616
1617/**
Ronald Cronab65c522021-11-24 10:47:20 +01001618 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1619 *
1620 * Enable TLS 1.3 middlebox compatibility mode.
1621 *
1622 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1623 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1624 * expecting TLS 1.2 traffic.
1625 *
1626 * Turning on the compatibility mode comes at the cost of a few added bytes
1627 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1628 * that don't use it. Therefore, unless transmission bandwidth is critical and
1629 * you know that middlebox compatibility issues won't occur, it is therefore
1630 * recommended to set this option.
1631 *
1632 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001633 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1634 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001635 *
1636 */
1637//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1638
1639/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001640 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1641 *
1642 * Enable TLS 1.3 PSK key exchange mode.
1643 *
1644 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1645 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1646 * effect on the build.
1647 *
1648 */
1649#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1650
1651/**
1652 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1653 *
1654 * Enable TLS 1.3 ephemeral key exchange mode.
1655 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001656 * Requires: PSA_WANT_ALG_ECDH
1657 * MBEDTLS_X509_CRT_PARSE_C
1658 * and at least one of:
1659 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1660 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001661 *
1662 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1663 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1664 * effect on the build.
1665 *
1666 */
1667#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1668
1669/**
1670 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1671 *
1672 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1673 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001674 * Requires: PSA_WANT_ALG_ECDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001675 *
1676 * Comment to disable support for the PSK ephemeral key exchange mode in
1677 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1678 * have any effect on the build.
1679 *
1680 */
1681#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1682
1683/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 * \def MBEDTLS_SSL_EARLY_DATA
1685 *
1686 * Enable support for RFC 8446 TLS 1.3 early data.
1687 *
1688 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1689 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1690 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1691 *
1692 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1693 * is not enabled, this option does not have any effect on the build.
1694 *
1695 * This feature is experimental, not completed and thus not ready for
1696 * production.
1697 *
1698 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001699//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001700
1701/**
Jerry Yu16f68532022-11-05 10:50:06 +08001702 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1703 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001704 * The default maximum amount of 0-RTT data. See the documentation of
1705 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1706 *
1707 * It must be positive and smaller than UINT32_MAX.
1708 *
1709 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1710 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001711 *
1712 * This feature is experimental, not completed and thus not ready for
1713 * production.
1714 *
1715 */
1716#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1717
1718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001720 *
1721 * Enable support for DTLS (all available versions).
1722 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001723 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001724 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001725 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001726 *
1727 * Comment this macro to disable support for DTLS
1728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001730
1731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001733 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001734 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001735 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001736 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001739
1740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001741 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001742 *
1743 * Enable support for the anti-replay mechanism in DTLS.
1744 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 * Requires: MBEDTLS_SSL_TLS_C
1746 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001747 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001748 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001749 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001750 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001751 * Comment this to disable anti-replay in DTLS.
1752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001754
1755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001757 *
1758 * Enable support for HelloVerifyRequest on DTLS servers.
1759 *
1760 * This feature is highly recommended to prevent DTLS servers being used as
1761 * amplifiers in DoS attacks against other hosts. It should always be enabled
1762 * unless you know for sure amplification cannot be a problem in the
1763 * environment in which your server operates.
1764 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001765 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001766 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001767 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001768 *
1769 * Comment this to disable support for HelloVerifyRequest.
1770 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001772
1773/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001774 * \def MBEDTLS_SSL_DTLS_SRTP
1775 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001776 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001777 * through the use_srtp extension.
1778 *
1779 * \note This feature provides the minimum functionality required
1780 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1781 * the associated SRTP packet protection key material.
1782 * In particular, the SRTP packet protection itself, as well as the
1783 * demultiplexing of RTP and DTLS packets at the datagram layer
1784 * (see Section 5 of RFC 5764), are not handled by this feature.
1785 * Instead, after successful completion of a handshake negotiating
1786 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001787 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001788 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1789 * (this is implemented in the SSL example programs).
1790 * The resulting key should then be passed to an SRTP stack.
1791 *
1792 * Setting this option enables the runtime API
1793 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1794 * through which the supported DTLS-SRTP protection
1795 * profiles can be configured. You must call this API at
1796 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001797 *
1798 * Requires: MBEDTLS_SSL_PROTO_DTLS
1799 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001800 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001801 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001802//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001803
1804/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001805 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1806 *
1807 * Enable server-side support for clients that reconnect from the same port.
1808 *
1809 * Some clients unexpectedly close the connection and try to reconnect using the
1810 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001811 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001812 * flag enables that support.
1813 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001814 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001815 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001816 * Comment this to disable support for clients reusing the source port.
1817 */
1818#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1819
1820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001822 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001823 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001824 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001825 * session store remains the responsibility of the application, though).
1826 * Server-side, you also need to provide callbacks for writing and parsing
1827 * tickets, including authenticated encryption and key management. Example
1828 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001829 *
1830 * Comment this macro to disable support for SSL session tickets
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001833
1834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001835 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001837 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001840 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001841 * Comment this macro to disable support for server name indication in SSL
1842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001843#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001844
1845/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001846 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1847 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001848 * When this option is enabled, the SSL buffer will be resized automatically
1849 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001850 *
1851 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001852 */
1853//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1854
1855/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001856 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1857 *
1858 * Enable testing of the constant-flow nature of some sensitive functions with
1859 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001860 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001861 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001862 * This setting requires compiling with clang -fsanitize=memory. The test
1863 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001864 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001865 * \warning This macro is only used for extended testing; it is not considered
1866 * part of the library's API, so it may change or disappear at any time.
1867 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001868 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001869 */
1870//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1871
1872/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001873 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1874 *
1875 * Enable testing of the constant-flow nature of some sensitive functions with
1876 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001877 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001878 *
1879 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001880 * testing if the tests suites are run with valgrind's memcheck. This can be
1881 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1882 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001883 *
1884 * \warning This macro is only used for extended testing; it is not considered
1885 * part of the library's API, so it may change or disappear at any time.
1886 *
1887 * Uncomment to enable testing of the constant-flow nature of selected code.
1888 */
1889//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1890
1891/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001892 * \def MBEDTLS_TEST_HOOKS
1893 *
1894 * Enable features for invasive testing such as introspection functions and
1895 * hooks for fault injection. This enables additional unit tests.
1896 *
1897 * Merely enabling this feature should not change the behavior of the product.
1898 * It only adds new code, and new branching points where the default behavior
1899 * is the same as when this feature is disabled.
1900 * However, this feature increases the attack surface: there is an added
1901 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1902 * Therefore this feature must never be enabled in production.
1903 *
1904 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1905 * information.
1906 *
1907 * Uncomment to enable invasive tests.
1908 */
1909//#define MBEDTLS_TEST_HOOKS
1910
1911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001913 *
1914 * Provide your own alternate threading implementation.
1915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001917 *
1918 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001921
1922/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001923 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001924 *
1925 * Enable the pthread wrapper layer for the threading layer.
1926 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001928 *
1929 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001932
1933/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001934 * \def MBEDTLS_USE_PSA_CRYPTO
1935 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001936 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1937 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001938 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001939 * \note Development of this option is currently in progress, and parts of Mbed
1940 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001941 * will still continue to work as usual, so enabling this option should not
1942 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001943 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001944 * \warning If you enable this option, you need to call `psa_crypto_init()`
1945 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001946 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001947 * \note An important and desirable effect of this option is that it allows
1948 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1949 * 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 +02001950 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001951 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1952 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001953 *
1954 * \note See docs/use-psa-crypto.md for a complete description this option.
1955 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001956 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001957 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001958 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001959 */
1960//#define MBEDTLS_USE_PSA_CRYPTO
1961
1962/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001963 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1964 *
John Durkop185764f2020-10-12 21:32:12 -07001965 * This setting allows support for cryptographic mechanisms through the PSA
1966 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001967 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001968 * When this option is disabled, the PSA API exposes the cryptographic
1969 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1970 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001971 *
1972 * When this option is enabled, the PSA API exposes the cryptographic
1973 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1974 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1975 * automatically enabled if required (i.e. if no PSA driver provides the
1976 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1977 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001978 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001979 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001980 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001981 *
John Durkop185764f2020-10-12 21:32:12 -07001982 * This feature is still experimental and is not ready for production since
1983 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001984 */
1985//#define MBEDTLS_PSA_CRYPTO_CONFIG
1986
1987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001989 *
1990 * Allow run-time checking of compile-time enabled features. Thus allowing users
1991 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001992 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001993 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001995 *
1996 * Comment this to disable run-time checking and save ROM space
1997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001999
2000/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002001 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2002 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002003 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002004 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2005 * the set of trusted certificates through a callback instead of a linked
2006 * list.
2007 *
2008 * This is useful for example in environments where a large number of trusted
2009 * certificates is present and storing them in a linked list isn't efficient
2010 * enough, or when the set of trusted certificates changes frequently.
2011 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002012 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002013 * `mbedtls_ssl_conf_ca_cb()` for more information.
2014 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002015 * Requires: MBEDTLS_X509_CRT_PARSE_C
2016 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002017 * Uncomment to enable trusted certificate callbacks.
2018 */
2019//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2020
2021/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002022 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002023 *
Chris Jones2c745862020-12-16 11:41:06 +00002024 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002025 *
Chris Jones2c745862020-12-16 11:41:06 +00002026 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002027 * and other functions/constants only used by these functions, thus reducing
2028 * the code footprint by several KB.
2029 */
Chris Jones2c745862020-12-16 11:41:06 +00002030//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002031
2032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002034 *
2035 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2036 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2037 *
2038 * Comment this macro to disallow using RSASSA-PSS in certificates.
2039 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002041/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002042
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002043/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002044 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002045 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002046 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002047 * \{
2048 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002049
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002052 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002053 * Enable AES-NI support on x86-64 or x86-32.
2054 *
2055 * \note AESNI is only supported with certain compilers and target options:
2056 * - Visual Studio 2013: supported.
2057 * - GCC, x86-64, target not explicitly supporting AESNI:
2058 * requires MBEDTLS_HAVE_ASM.
2059 * - GCC, x86-32, target not explicitly supporting AESNI:
2060 * not supported.
2061 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2062 * For this assembly-less implementation, you must currently compile
2063 * `library/aesni.c` and `library/aes.c` with machine options to enable
2064 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2065 * `clang -maes -mpclmul`.
2066 * - Non-x86 targets: this option is silently ignored.
2067 * - Other compilers: this option is silently ignored.
2068 *
2069 * \note
2070 * Above, "GCC" includes compatible compilers such as Clang.
2071 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002072 *
2073 * Module: library/aesni.c
2074 * Caller: library/aes.c
2075 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002076 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002077 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002078 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002079 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002080#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002081
2082/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002083 * \def MBEDTLS_AESCE_C
2084 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002085 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002086 *
2087 * Module: library/aesce.c
2088 * Caller: library/aes.c
2089 *
2090 * Requires: MBEDTLS_HAVE_ASM, MBEDTLS_AES_C
2091 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002092 * \warning Runtime detection only works on Linux. For non-Linux operating
2093 * system, Armv8-A Cryptographic Extensions must be supported by
2094 * the CPU when this option is enabled.
Jerry Yu330e6ae2023-02-21 14:51:38 +08002095 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002096 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002097 */
2098#define MBEDTLS_AESCE_C
2099
2100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002102 *
2103 * Enable the AES block cipher.
2104 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002105 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002106 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002107 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002108 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002109 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002110 * This module enables the following ciphersuites (if other requisites are
2111 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002112 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2113 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2114 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2115 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2116 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2117 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2118 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2122 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2123 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2124 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2125 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2126 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2127 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2128 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2129 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2130 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2131 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2132 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2133 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2134 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2135 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2136 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2137 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2138 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2140 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2141 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2142 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2143 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2144 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2145 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2146 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2147 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2148 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2149 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2150 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2151 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2152 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2153 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2154 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2155 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2156 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2157 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2158 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2159 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2160 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2161 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2162 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2164 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2165 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2166 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2167 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2168 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2169 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002170 *
Paul Bakkercff68422013-09-15 20:43:33 +02002171 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002174
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002177 *
2178 * Enable the generic ASN1 parser.
2179 *
2180 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002181 * Caller: library/x509.c
2182 * library/dhm.c
2183 * library/pkcs12.c
2184 * library/pkcs5.c
2185 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002188
2189/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002191 *
2192 * Enable the generic ASN1 writer.
2193 *
2194 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002195 * Caller: library/ecdsa.c
2196 * library/pkwrite.c
2197 * library/x509_create.c
2198 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002199 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002202
2203/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002204 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002205 *
2206 * Enable the Base64 module.
2207 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002208 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002209 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002210 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002211 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002213#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002214
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002215/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002217 *
Paul Bakker9a736322012-11-14 12:39:52 +00002218 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002219 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002220 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002221 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002222 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002223 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002224 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002225 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002226 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002227 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002228 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002229 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002230 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002231 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002234
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002237 *
2238 * Enable the Camellia block cipher.
2239 *
Paul Bakker38119b12009-01-10 23:31:23 +00002240 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002241 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002242 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002243 * This module enables the following ciphersuites (if other requisites are
2244 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002245 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2246 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2247 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2248 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2249 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2250 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2251 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2252 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2253 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2254 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2255 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2256 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2257 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2258 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2259 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2260 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2262 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2264 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2265 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2266 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2267 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2268 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2269 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2270 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2271 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2272 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2274 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2275 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2276 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2277 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2278 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2279 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2283 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2284 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2285 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002287 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002289
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002290/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002291 * \def MBEDTLS_ARIA_C
2292 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002293 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002294 *
2295 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002296 * Caller: library/cipher.c
2297 *
2298 * This module enables the following ciphersuites (if other requisites are
2299 * enabled as well):
2300 *
2301 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2302 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2303 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2304 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2305 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2306 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2307 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2308 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2309 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2310 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2311 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2312 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2313 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2314 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2315 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2316 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2317 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2318 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2319 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2320 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2321 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2322 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2323 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2324 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2325 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2326 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2327 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2328 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2329 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2330 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2331 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2332 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2333 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2334 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2335 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2336 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2337 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002339 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002340#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002341
2342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002344 *
2345 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2346 *
2347 * Module: library/ccm.c
2348 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002349 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2350 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002351 *
2352 * This module enables the AES-CCM ciphersuites, if other requisites are
2353 * enabled as well.
2354 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002356
2357/**
Daniel King34b822c2016-05-15 17:28:08 -03002358 * \def MBEDTLS_CHACHA20_C
2359 *
2360 * Enable the ChaCha20 stream cipher.
2361 *
2362 * Module: library/chacha20.c
2363 */
2364#define MBEDTLS_CHACHA20_C
2365
2366/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002367 * \def MBEDTLS_CHACHAPOLY_C
2368 *
2369 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2370 *
2371 * Module: library/chachapoly.c
2372 *
2373 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2374 */
2375#define MBEDTLS_CHACHAPOLY_C
2376
2377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002379 *
2380 * Enable the generic cipher layer.
2381 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002382 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002383 * Caller: library/ccm.c
2384 * library/cmac.c
2385 * library/gcm.c
2386 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002387 * library/pkcs12.c
2388 * library/pkcs5.c
2389 * library/psa_crypto_aead.c
2390 * library/psa_crypto_mac.c
2391 * library/ssl_ciphersuites.c
2392 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002393 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002394 *
2395 * Uncomment to enable generic cipher wrappers.
2396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002398
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002399/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002400 * \def MBEDTLS_CMAC_C
2401 *
Simon Butcher327398a2016-10-05 14:09:11 +01002402 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2403 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002404 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002405 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2406 * implementation of the CMAC algorithm is provided by an alternate
2407 * implementation, that alternate implementation may opt to not support
2408 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2409 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002410 * Module: library/cmac.c
2411 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002412 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002413 *
2414 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002415#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002416
2417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002419 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002420 * Enable the CTR_DRBG AES-based random generator.
2421 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002422 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002423 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002424 * \note To achieve a 256-bit security strength with CTR_DRBG,
2425 * you must use AES-256 *and* use sufficient entropy.
2426 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002427 *
2428 * Module: library/ctr_drbg.c
2429 * Caller:
2430 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002432 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002433 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002435#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002436
2437/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002439 *
2440 * Enable the debug functions.
2441 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002442 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002443 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002444 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002445 * library/ssl_tls12_*.c
2446 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002447 *
2448 * This module provides debugging functions.
2449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002450#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002451
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002452/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002453 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002454 *
2455 * Enable the DES block cipher.
2456 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002457 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002458 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002459 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002460 *
Paul Bakkercff68422013-09-15 20:43:33 +02002461 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002462 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002463 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002464 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002467
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002468/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002470 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002471 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002472 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002473 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002474 * Caller: library/ssl_tls.c
2475 * library/ssl*_client.c
2476 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002477 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002478 * This module is used by the following key exchanges:
2479 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002480 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002481 * \warning Using DHE constitutes a security risk as it
2482 * is not possible to validate custom DH parameters.
2483 * If possible, it is recommended users should consider
2484 * preferring other methods of key exchange.
2485 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002486 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002488#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002489
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002492 *
2493 * Enable the elliptic curve Diffie-Hellman library.
2494 *
2495 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002496 * Caller: library/psa_crypto.c
2497 * library/ssl_tls.c
2498 * library/ssl*_client.c
2499 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002500 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002501 * This module is used by the following key exchanges:
2502 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002503 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002506#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002507
2508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002510 *
2511 * Enable the elliptic curve DSA library.
2512 *
2513 * Module: library/ecdsa.c
2514 * Caller:
2515 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002516 * This module is used by the following key exchanges:
2517 * ECDHE-ECDSA
2518 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002519 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2520 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2521 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002524
2525/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002526 * \def MBEDTLS_ECJPAKE_C
2527 *
2528 * Enable the elliptic curve J-PAKE library.
2529 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002530 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2531 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002532 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002533 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002534 * Module: library/ecjpake.c
2535 * Caller:
2536 *
2537 * This module is used by the following key exchanges:
2538 * ECJPAKE
2539 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002540 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002541 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002542 * \warning If using a hash that is only provided by PSA drivers, you must
2543 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002544 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002545#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002546
2547/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002549 *
2550 * Enable the elliptic curve over GF(p) library.
2551 *
2552 * Module: library/ecp.c
2553 * Caller: library/ecdh.c
2554 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002555 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002556 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560
2561/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002563 *
2564 * Enable the platform-specific entropy code.
2565 *
2566 * Module: library/entropy.c
2567 * Caller:
2568 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002570 *
2571 * This module provides a generic entropy pool
2572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002574
2575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002577 *
2578 * Enable error code to error string conversion.
2579 *
2580 * Module: library/error.c
2581 * Caller:
2582 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002583 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002586
2587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002589 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002590 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002591 *
2592 * Module: library/gcm.c
2593 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002594 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2595 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002596 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002597 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2598 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002601
2602/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002603 * \def MBEDTLS_HKDF_C
2604 *
2605 * Enable the HKDF algorithm (RFC 5869).
2606 *
2607 * Module: library/hkdf.c
2608 * Caller:
2609 *
2610 * Requires: MBEDTLS_MD_C
2611 *
2612 * This module adds support for the Hashed Message Authentication Code
2613 * (HMAC)-based key derivation function (HKDF).
2614 */
2615#define MBEDTLS_HKDF_C
2616
2617/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002619 *
2620 * Enable the HMAC_DRBG random generator.
2621 *
2622 * Module: library/hmac_drbg.c
2623 * Caller:
2624 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002625 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002626 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002627 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002630
2631/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002632 * \def MBEDTLS_LMS_C
2633 *
2634 * Enable the LMS stateful-hash asymmetric signature algorithm.
2635 *
2636 * Module: library/lms.c
2637 * Caller:
2638 *
Raef Colesab4f8742022-09-01 12:24:31 +01002639 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002640 *
Raef Colesab4f8742022-09-01 12:24:31 +01002641 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002642 */
2643#define MBEDTLS_LMS_C
2644
2645/**
Raef Colesab4f8742022-09-01 12:24:31 +01002646 * \def MBEDTLS_LMS_PRIVATE
2647 *
2648 * Enable LMS private-key operations and signing code. Functions enabled by this
2649 * option are experimental, and should not be used in production.
2650 *
2651 * Requires: MBEDTLS_LMS_C
2652 *
2653 * Uncomment to enable the LMS signature algorithm and private key operations.
2654 */
Raef Coles5127e852022-10-07 10:35:56 +01002655//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002656
2657/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002658 * \def MBEDTLS_NIST_KW_C
2659 *
2660 * Enable the Key Wrapping mode for 128-bit block ciphers,
2661 * as defined in NIST SP 800-38F. Only KW and KWP modes
2662 * are supported. At the moment, only AES is approved by NIST.
2663 *
2664 * Module: library/nist_kw.c
2665 *
2666 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2667 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002668#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002669
2670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002672 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002673 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002674 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002675 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2676 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002677 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002678 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002679 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002680 * Caller: library/constant_time.c
2681 * library/ecdsa.c
2682 * library/ecjpake.c
2683 * library/hkdf.c
2684 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002685 * library/pk.c
2686 * library/pkcs5.c
2687 * library/pkcs12.c
2688 * library/psa_crypto_ecp.c
2689 * library/psa_crypto_rsa.c
2690 * library/rsa.c
2691 * library/ssl_cookie.c
2692 * library/ssl_msg.c
2693 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002694 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002695 * library/x509_crt.c
2696 * library/x509write_crt.c
2697 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002698 *
2699 * Uncomment to enable generic message digest wrappers.
2700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002702
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002703/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002705 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002706 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002707 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002708 * Module: library/md5.c
2709 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002710 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002711 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002712 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002713 * This module is required for TLS 1.2 depending on the handshake parameters.
2714 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2715 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002716 *
2717 * \warning MD5 is considered a weak message digest and its use constitutes a
2718 * security risk. If possible, we recommend avoiding dependencies on
2719 * it, and considering stronger message digests instead.
2720 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002723
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002726 *
2727 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002728 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002729 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002730 *
2731 * Module: library/memory_buffer_alloc.c
2732 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002733 * Requires: MBEDTLS_PLATFORM_C
2734 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002735 *
2736 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002737 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002739
2740/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002742 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002743 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2744 *
Simon Butcherd567a232016-03-09 20:19:21 +00002745 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2746 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002747 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002748 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002749 * \note See also our Knowledge Base article about porting to a new
2750 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002751 * 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 +00002752 *
Andres AG788aa4a2016-09-14 14:32:09 +01002753 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002754 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002755 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002758
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002760 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002762 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002763 *
2764 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002765 * Caller: library/asn1write.c
2766 * library/pkcs5.c
2767 * library/pkparse.c
2768 * library/pkwrite.c
2769 * library/rsa.c
2770 * library/x509.c
2771 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002772 * library/x509_crl.c
2773 * library/x509_crt.c
2774 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002775 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002776 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002777 *
2778 * This modules translates between OIDs and internal values.
2779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002781
2782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002784 *
2785 * Enable VIA Padlock support on x86.
2786 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002787 * Module: library/padlock.c
2788 * Caller: library/aes.c
2789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002791 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 * This modules adds support for the VIA PadLock on x86.
2793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002795
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002798 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002799 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002800 *
2801 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002802 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002803 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002804 * library/x509_crl.c
2805 * library/x509_crt.c
2806 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002807 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002809 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2810 *
2811 * \warning When parsing password-protected files, if MD5 is provided only by
2812 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002813 *
Paul Bakkercff68422013-09-15 20:43:33 +02002814 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002817
2818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002821 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002822 *
2823 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002824 * Caller: library/pkwrite.c
2825 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002826 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002829 *
2830 * This modules adds support for encoding / writing PEM files.
2831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002833
2834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002836 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002837 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002838 *
2839 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002840 * Caller: library/psa_crypto_rsa.c
2841 * library/ssl_tls.c
2842 * library/ssl*_client.c
2843 * library/ssl*_server.c
2844 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002845 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002846 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002847 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002848 * Uncomment to enable generic public key wrappers.
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002851
2852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002854 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002855 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002856 *
2857 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002858 * Caller: library/x509_crt.c
2859 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002860 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002862 *
2863 * Uncomment to enable generic public key parse functions.
2864 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002865#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002866
2867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002869 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002870 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002871 *
2872 * Module: library/pkwrite.c
2873 * Caller: library/x509write.c
2874 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002876 *
2877 * Uncomment to enable generic public key write functions.
2878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002880
2881/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002883 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002884 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002885 *
2886 * Module: library/pkcs5.c
2887 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002888 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002889 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002890 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002891 * \warning If using a hash that is only provided by PSA drivers, you must
2892 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002893 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002894 * This module adds support for the PKCS#5 functions.
2895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002896#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002897
2898/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002899 * \def MBEDTLS_PKCS7_C
2900 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002901 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002902 * RFC Link - https://tools.ietf.org/html/rfc2315
2903 *
2904 * Module: library/pkcs7.c
2905 *
2906 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002907 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2908 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002909 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002910 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002911 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002912#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002913
2914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002917 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002918 * Adds algorithms for parsing PKCS#8 encrypted private keys
2919 *
2920 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002921 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002922 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002923 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2924 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2925 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002926 * \warning If using a hash that is only provided by PSA drivers, you must
2927 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002928 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002929 * This module enables PKCS#12 functions.
2930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002931#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002932
2933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002935 *
2936 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002937 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002938 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2940 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002941 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002942 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002943 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002944 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002945 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002946 * Module: library/platform.c
2947 * Caller: Most other .c files
2948 *
2949 * This module enables abstraction of common (libc) functions.
2950 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002951#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002952
2953/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002954 * \def MBEDTLS_POLY1305_C
2955 *
2956 * Enable the Poly1305 MAC algorithm.
2957 *
2958 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002959 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002960 */
2961#define MBEDTLS_POLY1305_C
2962
2963/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002964 * \def MBEDTLS_PSA_CRYPTO_C
2965 *
2966 * Enable the Platform Security Architecture cryptography API.
2967 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002968 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002969 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002970 * Requires: MBEDTLS_CIPHER_C,
2971 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002972 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002973 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002974 *
2975 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002976#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002977
2978/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002979 * \def MBEDTLS_PSA_CRYPTO_SE_C
2980 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002981 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002982 * cryptography API.
2983 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002984 * \deprecated This feature is deprecated. Please switch to the driver
2985 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002986 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002987 * Module: library/psa_crypto_se.c
2988 *
2989 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2990 *
2991 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002992//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002993
2994/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002995 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2996 *
2997 * Enable the Platform Security Architecture persistent key storage.
2998 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002999 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003000 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003001 * Requires: MBEDTLS_PSA_CRYPTO_C,
3002 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3003 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003004 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003005#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003006
3007/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003008 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003009 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003010 * Enable the emulation of the Platform Security Architecture
3011 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003012 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003013 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003014 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003015 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003016 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003017#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003018
3019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003020 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003021 *
3022 * Enable the RIPEMD-160 hash algorithm.
3023 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003024 * Module: library/ripemd160.c
3025 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003026 *
3027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003029
3030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003031 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003032 *
3033 * Enable the RSA public-key cryptosystem.
3034 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003035 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003036 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003037 * Caller: library/pk.c
3038 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003039 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003040 * library/ssl*_client.c
3041 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003042 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003043 * This module is used by the following key exchanges:
3044 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003045 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003047 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003048#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003049
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003052 *
3053 * Enable the SHA1 cryptographic hash algorithm.
3054 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003055 * Module: library/sha1.c
3056 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003057 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003059 * This module is required for TLS 1.2 depending on the handshake parameters,
3060 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003061 *
3062 * \warning SHA-1 is considered a weak message digest and its use constitutes
3063 * a security risk. If possible, we recommend avoiding dependencies
3064 * on it, and considering stronger message digests instead.
3065 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003068
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003069/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003070 * \def MBEDTLS_SHA224_C
3071 *
3072 * Enable the SHA-224 cryptographic hash algorithm.
3073 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003074 * Module: library/sha256.c
3075 * Caller: library/md.c
3076 * library/ssl_cookie.c
3077 *
3078 * This module adds support for SHA-224.
3079 */
3080#define MBEDTLS_SHA224_C
3081
3082/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003083 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003084 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003085 * Enable the SHA-256 cryptographic hash algorithm.
3086 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003087 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003088 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003089 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003090 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003091 * library/ssl*_client.c
3092 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003093 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003094 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003095 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003096 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003098
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003099/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003100 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3101 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003102 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3103 * with the ARMv8 cryptographic extensions if they are available at runtime.
3104 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003105 *
3106 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3107 * for a non-Aarch64 build it will be silently ignored.
3108 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003109 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3110 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3111 *
3112 * Requires: MBEDTLS_SHA256_C.
3113 *
3114 * Module: library/sha256.c
3115 *
3116 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3117 * and use them if available.
3118 */
3119//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3120
3121/**
3122 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3123 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003124 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3125 * with the ARMv8 cryptographic extensions, which must be available at runtime
3126 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003127 *
3128 * \note This allows builds with a smaller code size than with
3129 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3130 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003131 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3132 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3133 *
3134 * Requires: MBEDTLS_SHA256_C.
3135 *
3136 * Module: library/sha256.c
3137 *
3138 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3139 * unconditionally.
3140 */
3141//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3142
3143/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003144 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003145 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003146 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003147 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003148 * Module: library/sha512.c
3149 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003150 * library/psa_crypto_hash.c
3151 * library/ssl_tls.c
3152 * library/ssl*_client.c
3153 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003154 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003155 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003156 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003157#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003158
3159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003161 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003162 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003163 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003164 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003165 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003166 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003167 * library/ssl_tls.c
3168 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003169 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003170 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003173
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003174/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003175 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3176 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003177 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3178 * with the ARMv8 cryptographic extensions if they are available at runtime.
3179 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003180 *
3181 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3182 * for a non-Aarch64 build it will be silently ignored.
3183 *
3184 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003185 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003186 *
3187 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3188 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3189 *
3190 * Requires: MBEDTLS_SHA512_C.
3191 *
3192 * Module: library/sha512.c
3193 *
3194 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3195 * and use them if available.
3196 */
3197//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3198
3199/**
3200 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3201 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003202 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3203 * with the ARMv8 cryptographic extensions, which must be available at runtime
3204 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003205 *
3206 * \note This allows builds with a smaller code size than with
3207 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3208 *
3209 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003210 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003211 *
3212 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3213 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3214 *
3215 * Requires: MBEDTLS_SHA512_C.
3216 *
3217 * Module: library/sha512.c
3218 *
3219 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3220 * unconditionally.
3221 */
3222//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3223
3224/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003226 *
3227 * Enable simple SSL cache implementation.
3228 *
3229 * Module: library/ssl_cache.c
3230 * Caller:
3231 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003232 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003235
3236/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003238 *
3239 * Enable basic implementation of DTLS cookies for hello verification.
3240 *
3241 * Module: library/ssl_cookie.c
3242 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003245
3246/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003247 * \def MBEDTLS_SSL_TICKET_C
3248 *
3249 * Enable an implementation of TLS server-side callbacks for session tickets.
3250 *
3251 * Module: library/ssl_ticket.c
3252 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003253 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003254 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3255 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003256 */
3257#define MBEDTLS_SSL_TICKET_C
3258
3259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003261 *
3262 * Enable the SSL/TLS client code.
3263 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003264 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003265 * Caller:
3266 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003268 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003269 * This module is required for SSL/TLS client support.
3270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003272
Paul Bakker9a736322012-11-14 12:39:52 +00003273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003274 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003275 *
3276 * Enable the SSL/TLS server code.
3277 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003278 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003279 * Caller:
3280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003281 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003282 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003283 * This module is required for SSL/TLS server support.
3284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003286
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003288 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003289 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003290 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003291 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003292 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003293 * Caller: library/ssl*_client.c
3294 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003295 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3297 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003298 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003299 * This module is required for SSL/TLS.
3300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003302
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003303/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003304 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003305 *
3306 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003307 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003308 * contexts are not shared between threads. If you do intend to use contexts
3309 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003310 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003311 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003312 *
3313 * Module: library/threading.c
3314 *
3315 * This allows different threading implementations (self-implemented or
3316 * provided).
3317 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 * You will have to enable either MBEDTLS_THREADING_ALT or
3319 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003320 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003321 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003324
3325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003327 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003328 * Enable the semi-portable timing interface.
3329 *
Simon Butcherd567a232016-03-09 20:19:21 +00003330 * \note The provided implementation only works on POSIX/Unix (including Linux,
3331 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003332 * module and provide your own implementations of the callbacks needed by
3333 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3334 * your own implementation of the whole module by setting
3335 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003336 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003337 * \note The timing module will include time.h on suitable platforms
3338 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3339 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3340 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003341 * \note See also our Knowledge Base article about porting to a new
3342 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003343 * 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 +00003344 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003345 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003348
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003351 *
3352 * Enable run-time version information.
3353 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003354 * Module: library/version.c
3355 *
3356 * This module provides run-time version information.
3357 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003359
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003360/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003362 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003363 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003364 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003365 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003366 * Caller: library/x509_crl.c
3367 * library/x509_crt.c
3368 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003369 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003370 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003371 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3372 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003373 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3374 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003375 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003376 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003379
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003382 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003383 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003384 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003385 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003386 * Caller: library/ssl_tls.c
3387 * library/ssl*_client.c
3388 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003389 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003391 *
3392 * This module is required for X.509 certificate parsing.
3393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003395
3396/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003398 *
3399 * Enable X.509 CRL parsing.
3400 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003401 * Module: library/x509_crl.c
3402 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003403 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003405 *
3406 * This module is required for X.509 CRL parsing.
3407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003409
3410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003412 *
3413 * Enable X.509 Certificate Signing Request (CSR) parsing.
3414 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003415 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003416 * Caller: library/x509_crt_write.c
3417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003419 *
3420 * This module is used for reading X.509 certificate request.
3421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003423
3424/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003426 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003427 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003428 *
3429 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003430 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003431 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003432 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3433 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003434 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3435 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003436 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003437 * This module is the basis for creating X.509 certificates and CSRs.
3438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003440
3441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003442 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003443 *
3444 * Enable creating X.509 certificates.
3445 *
3446 * Module: library/x509_crt_write.c
3447 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003448 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003449 *
3450 * This module is required for X.509 certificate creation.
3451 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003452#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003453
3454/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003456 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003457 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003458 *
3459 * Module: library/x509_csr_write.c
3460 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003462 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003463 * This module is required for X.509 certificate request writing.
3464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003465#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003466
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003467/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003468
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003469/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003470 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003471 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003472 * This section contains Mbed TLS build settings that are not associated
3473 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003474 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003475 * \{
3476 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003477
Gilles Peskinea02c1242022-03-16 17:03:19 +01003478/**
3479 * \def MBEDTLS_CONFIG_FILE
3480 *
3481 * If defined, this is a header which will be included instead of
3482 * `"mbedtls/mbedtls_config.h"`.
3483 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003484 * Unlike other configuration options, this one must be defined on the
3485 * compiler command line: a definition in `mbedtls_config.h` would have
3486 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003487 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003488 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003489 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003490 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003491 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003492 * The value of this symbol is typically a path in double quotes, either
3493 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003494 */
3495//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3496
3497/**
3498 * \def MBEDTLS_USER_CONFIG_FILE
3499 *
3500 * If defined, this is a header which will be included after
3501 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003502 * This allows you to modify the default configuration, including the ability
3503 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003504 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003505 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003506 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003507 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003508 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003509 * The value of this symbol is typically a path in double quotes, either
3510 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003511 */
3512//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3513
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003514/**
3515 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3516 *
3517 * If defined, this is a header which will be included instead of
3518 * `"psa/crypto_config.h"`.
3519 * This header file specifies which cryptographic mechanisms are available
3520 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3521 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3522 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003523 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003524 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003525 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003526 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003527 * The value of this symbol is typically a path in double quotes, either
3528 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003529 */
3530//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3531
3532/**
3533 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3534 *
3535 * If defined, this is a header which will be included after
3536 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003537 * This allows you to modify the default configuration, including the ability
3538 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003539 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003540 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003541 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003542 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003543 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003544 * The value of this symbol is typically a path in double quotes, either
3545 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003546 */
3547//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3548
Gilles Peskineb1176f22023-02-22 22:07:28 +01003549/**
3550 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3551 *
3552 * If defined, this is a header which will be included instead of
3553 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3554 * as the one in Mbed TLS, but with definitions adapted to the platform on
3555 * which the library code will run.
3556 *
3557 * \note The required content of this header can vary from one version of
3558 * Mbed TLS to the next. Integrators who provide an alternative file
3559 * should review the changes in the original file whenever they
3560 * upgrade Mbed TLS.
3561 *
3562 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3563 * non-standard feature of the C language, so this feature is only available
3564 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3565 *
3566 * 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.
3568 */
3569//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3570
3571/**
3572 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3573 *
3574 * If defined, this is a header which will be included instead of
3575 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3576 * as the one in Mbed TLS, but with definitions adapted to the environment
3577 * in which the library code will run. The typical use for this feature
3578 * is to provide alternative type definitions on the client side in
3579 * client-server integrations of PSA crypto, where operation structures
3580 * contain handles instead of cryptographic data.
3581 *
3582 * \note The required content of this header can vary from one version of
3583 * Mbed TLS to the next. Integrators who provide an alternative file
3584 * should review the changes in the original file whenever they
3585 * upgrade Mbed TLS.
3586 *
3587 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3588 * non-standard feature of the C language, so this feature is only available
3589 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3590 *
3591 * The value of this symbol is typically a path in double quotes, either
3592 * absolute or relative to a directory on the include search path.
3593 */
3594//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3595
Gilles Peskineba4162a2022-04-11 17:04:38 +02003596/** \} name SECTION: General configuration options */
3597
3598/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003599 * \name SECTION: Module configuration options
3600 *
3601 * This section allows for the setting of module specific sizes and
3602 * configuration options. The default values are already present in the
3603 * relevant header files and should suffice for the regular use cases.
3604 *
3605 * Our advice is to enable options and change their values here
3606 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003607 * \{
3608 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003609/* The Doxygen documentation here is used when a user comments out a
3610 * setting and runs doxygen themselves. On the other hand, when we typeset
3611 * the full documentation including disabled settings, the documentation
3612 * in specific modules' header files is used if present. When editing this
3613 * file, make sure that each option is documented in exactly one place,
3614 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3615 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003616
Paul Bakker088c5c52014-04-25 11:11:10 +02003617/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003618//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003619//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003620
Paul Bakker088c5c52014-04-25 11:11:10 +02003621/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3623//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3624//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3625//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3626//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003627
Paul Bakker088c5c52014-04-25 11:11:10 +02003628/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003629//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3630//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3631//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3632//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003633
Paul Bakker088c5c52014-04-25 11:11:10 +02003634/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003635//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003637
Paul Bakker088c5c52014-04-25 11:11:10 +02003638/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003639//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3640//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003641//#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 +01003642
Paul Bakker088c5c52014-04-25 11:11:10 +02003643/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003644//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003645
Paul Bakker088c5c52014-04-25 11:11:10 +02003646/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647//#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 +02003648//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003650//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003651//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003652//#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 +02003653//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3654//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003655/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003656//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003657//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3658//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003659//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3660//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3661//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003663/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3664/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003665//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003666//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3667//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003668//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003669//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3670//#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 +02003671//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3672//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003673/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003674//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003675//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003676//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3677//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003678
Gilles Peskine3f106f72021-09-23 17:42:39 +02003679/** \def MBEDTLS_CHECK_RETURN
3680 *
3681 * This macro is used at the beginning of the declaration of a function
3682 * to indicate that its return value should be checked. It should
3683 * instruct the compiler to emit a warning or an error if the function
3684 * is called without checking its return value.
3685 *
3686 * There is a default implementation for popular compilers in platform_util.h.
3687 * You can override the default implementation by defining your own here.
3688 *
3689 * If the implementation here is empty, this will effectively disable the
3690 * checking of functions' return values.
3691 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003692//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003693
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003694/** \def MBEDTLS_IGNORE_RETURN
3695 *
3696 * This macro requires one argument, which should be a C function call.
3697 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3698 * warning is suppressed.
3699 */
3700//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3701
Gilles Peskineed038902020-11-13 21:33:21 +01003702/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003703/**
Gilles Peskineed038902020-11-13 21:33:21 +01003704 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3705 * PSA crypto subsystem.
3706 *
3707 * If this option is unset:
3708 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003709 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003710 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3711 * on unspecified heuristics.
3712 */
3713//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3714
Steven Cooreman863470a2021-02-15 14:03:19 +01003715/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003716 * Restrict the PSA library to supporting a maximum amount of simultaneously
3717 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3718 * volatile key, or a persistent key which is loaded temporarily by the
3719 * library as part of a crypto operation in flight.
3720 *
3721 * If this option is unset, the library will fall back to a default value of
3722 * 32 keys.
3723 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003724//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003725
Paul Bakker088c5c52014-04-25 11:11:10 +02003726/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3728//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003729
Paul Bakker088c5c52014-04-25 11:11:10 +02003730/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003731
Angus Grattond8213d02016-05-25 20:56:48 +10003732/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3733 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003734 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003735 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003736 * This determines the size of the incoming TLS I/O buffer in such a way
3737 * that it is capable of holding the specified amount of plaintext data,
3738 * regardless of the protection mechanism used.
3739 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003740 * \note When using a value less than the default of 16KB on the client, it is
3741 * recommended to use the Maximum Fragment Length (MFL) extension to
3742 * inform the server about this limitation. On the server, there
3743 * is no supported, standardized way of informing the client about
3744 * restriction on the maximum size of incoming messages, and unless
3745 * the limitation has been communicated by other means, it is recommended
3746 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3747 * while keeping the default value of 16KB for the incoming buffer.
3748 *
David Horstmann95d516f2021-05-04 18:36:56 +01003749 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003750 */
3751//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3752
Gilles Peskined3d02902020-03-04 21:35:27 +01003753/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3754 *
3755 * The maximum length of CIDs used for incoming DTLS messages.
3756 *
3757 */
3758//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3759
3760/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3761 *
3762 * The maximum length of CIDs used for outgoing DTLS messages.
3763 *
3764 */
3765//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3766
TRodziewicze8dd7092021-05-12 14:19:11 +02003767/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003768 *
3769 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003770 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003771 *
3772 * The padding will always be chosen so that the length of the
3773 * padded plaintext is a multiple of the value of this option.
3774 *
3775 * Note: A value of \c 1 means that no padding will be used
3776 * for outgoing records.
3777 *
3778 * Note: On systems lacking division instructions,
3779 * a power of two should be preferred.
3780 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003781//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003782
Angus Grattond8213d02016-05-25 20:56:48 +10003783/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3784 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003785 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003786 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003787 * This determines the size of the outgoing TLS I/O buffer in such a way
3788 * that it is capable of holding the specified amount of plaintext data,
3789 * regardless of the protection mechanism used.
3790 *
Angus Grattond8213d02016-05-25 20:56:48 +10003791 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3792 * the default inward 16384 byte buffer to conform to the TLS specification.
3793 *
3794 * The minimum required outward buffer size is determined by the handshake
3795 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3796 * The specific size requirement depends on the configured ciphers and any
3797 * certificate data which is sent during the handshake.
3798 *
David Horstmann95d516f2021-05-04 18:36:56 +01003799 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003800 */
3801//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3802
Hanno Beckere0b150f2018-08-21 15:51:03 +01003803/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3804 *
3805 * Maximum number of heap-allocated bytes for the purpose of
3806 * DTLS handshake message reassembly and future message buffering.
3807 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003808 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003809 * to account for a reassembled handshake message of maximum size,
3810 * together with its reassembly bitmap.
3811 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003812 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003813 * should be sufficient for all practical situations as it allows
3814 * to reassembly a large handshake message (such as a certificate)
3815 * while buffering multiple smaller handshake messages.
3816 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003817 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003818//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003819
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003820//#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 +02003821//#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 +02003822
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003823/**
3824 * Complete list of ciphersuites to use, in order of preference.
3825 *
3826 * \warning No dependency checking is done on that field! This option can only
3827 * be used to restrict the set of available ciphersuites. It is your
3828 * responsibility to make sure the needed modules are active.
3829 *
3830 * Use this to save a few hundred bytes of ROM (default ordering of all
3831 * available ciphersuites) and a few to a few hundred bytes of RAM.
3832 *
3833 * The value below is only an example, not the default.
3834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003835//#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 +02003836
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003837/**
3838 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3839 *
3840 * Maximum time difference in milliseconds tolerated between the age of a
3841 * ticket from the server and client point of view.
3842 * From the client point of view, the age of a ticket is the time difference
3843 * between the time when the client proposes to the server to use the ticket
3844 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3845 * the time the client received the ticket from the server.
3846 * From the server point of view, the age of a ticket is the time difference
3847 * between the time when the server receives a proposition from the client
3848 * to use the ticket and the time when the ticket was created by the server.
3849 * The server age is expected to be always greater than the client one and
3850 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3851 * maximum difference tolerated for the server to accept the ticket.
3852 * This is not used in TLS 1.2.
3853 *
3854 */
3855#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3856
3857/**
3858 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3859 *
3860 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3861 *
3862 * This must be less than 256.
3863 */
3864#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3865
3866/**
3867 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3868 *
3869 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3870 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3871 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3872 *
3873 */
3874#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3875
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003876/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003877//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003878//#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 +01003879
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003880/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003881 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003882 * mbedtls_platform_zeroize(). This replaces the default implementation in
3883 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003884 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003885 * mbedtls_platform_zeroize() is a widely used function across the library to
3886 * zero a block of memory. The implementation is expected to be secure in the
3887 * sense that it has been written to prevent the compiler from removing calls
3888 * to mbedtls_platform_zeroize() as part of redundant code elimination
3889 * optimizations. However, it is difficult to guarantee that calls to
3890 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3891 * versions of the C language standards do not provide a secure implementation
3892 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3893 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003894 * example by using directives specific to their compiler, features from newer
3895 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003896 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003897 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003898//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003899
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003900/**
3901 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003902 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003903 * platform_util.c.
3904 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003905 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003906 * library will try to use safer implementations of this function, such as
3907 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003908 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003909 * using the standard gmtime(). In this case, calls from the library to
3910 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003911 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003912 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003913 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3914 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3915 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003916 */
Hanno Becker6a739782018-09-05 15:06:19 +01003917//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003918
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003919/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003920 * Enable the verified implementations of ECDH primitives from Project Everest
3921 * (currently only Curve25519). This feature changes the layout of ECDH
3922 * contexts and therefore is a compatibility break for applications that access
3923 * fields of a mbedtls_ecdh_context structure directly. See also
3924 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003925 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003926//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003927
Gilles Peskine611179c2022-04-13 23:04:48 +02003928/** \} name SECTION: Module configuration options */