blob: cc66ff72e8966189fc1dd979c2eabab8c673a5ec [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
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010059 * MBEDTLS_AESNI_C
60 * 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é-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 * Requires: MBEDTLS_ECDH_C
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é-Gonnard2cf5a7c2015-04-08 12:49:31 +0200902 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
903 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 *
905 * This enables the following ciphersuites (if other requisites are
906 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
913 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
914 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
915 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
916 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200919
920/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200922 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200923 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200924 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 *
927 * This enables the following ciphersuites (if other requisites are
928 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
935 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
936 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
938 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200941
942/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100944 *
945 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
946 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200947 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 *
949 * This enables the following ciphersuites (if other requisites are
950 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
957 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
958 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
959 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
960 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100961 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100963
964/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966 *
967 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
968 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200969 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970 *
971 * This enables the following ciphersuites (if other requisites are
972 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
975 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
977 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
979 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
980 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
981 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
982 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100985
986/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200987 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
988 *
989 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
990 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200991 * \warning This is currently experimental. EC J-PAKE support is based on the
992 * Thread v1.0.0 specification; incompatible changes to the specification
993 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200994 *
995 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200996 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200997 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
998 *
999 * This enables the following ciphersuites (if other requisites are
1000 * enabled as well):
1001 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1002 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001003//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001004
1005/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001007 *
1008 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1009 * RFC 5915 and RFC 5480.
1010 *
1011 * Currently this means parsing the SpecifiedECDomain choice of EC
1012 * parameters (only known groups are supported, not arbitrary domains, to
1013 * avoid validation issues).
1014 *
1015 * Disable if you only need to support RFC 5915 + 5480 key formats.
1016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001021 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022 * Enable a dummy error function to make use of mbedtls_strerror() in
1023 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1024 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1027 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001028 *
1029 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001031 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001033
1034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001036 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001037 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001041#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001042
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001045 *
1046 * Enable functions that use the filesystem.
1047 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001049
1050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001052 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001053 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001054 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001055 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001056 * application.
1057 *
1058 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001061
1062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001064 *
1065 * Do not use built-in platform entropy functions.
1066 * This is useful if your platform does not support
1067 * standards like the /dev/urandom or Windows CryptoAPI.
1068 *
1069 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001072
1073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001075 *
1076 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1077 * default SHA-512 based one (if both are available).
1078 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001080 *
1081 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1082 * if you have performance concerns.
1083 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001084 * This option is only useful if both MBEDTLS_SHA256_C and
1085 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001086 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001087//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001088
1089/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001090 * \def MBEDTLS_ENTROPY_NV_SEED
1091 *
1092 * Enable the non-volatile (NV) seed file-based entropy source.
1093 * (Also enables the NV seed read/write functions in the platform layer)
1094 *
1095 * This is crucial (if not required) on systems that do not have a
1096 * cryptographic entropy source (in hardware or kernel) available.
1097 *
1098 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1099 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001100 * \note The read/write functions that are used by the entropy source are
1101 * determined in the platform layer, and can be modified at runtime and/or
1102 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1103 *
1104 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001105 * with regular fopen(), please make sure you make a seedfile with the
1106 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1107 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001108 * and written to or you will get an entropy source error! The default
1109 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1110 * bytes from the file.
1111 *
1112 * \note The entropy collector will write to the seed file before entropy is
1113 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001114 */
1115//#define MBEDTLS_ENTROPY_NV_SEED
1116
Ronald Cron71016a92020-08-28 19:01:50 +02001117/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001118 *
Ronald Cron71016a92020-08-28 19:01:50 +02001119 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001120 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001121 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1122 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001123 *
1124 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001125 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001126 */
Ronald Cron71016a92020-08-28 19:01:50 +02001127//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001128
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001131 *
1132 * Enable debugging of buffer allocator memory issues. Automatically prints
1133 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1134 * function for 'debug output' of allocated memory.
1135 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001137 *
1138 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001139 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001141
1142/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001144 *
1145 * Include backtrace information with each allocated block.
1146 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001147 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001148 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001149 *
1150 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001152//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001153
1154/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001156 *
1157 * Support external private RSA keys (eg from a HSM) in the PK layer.
1158 *
1159 * Comment this macro to disable support for external private RSA keys.
1160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001165 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001166 * Enable support for PKCS#1 v1.5 encoding.
1167 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001168 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001169 *
Paul Bakker48377d92013-08-30 12:06:24 +02001170 * This enables support for PKCS#1 v1.5 operations.
1171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001173
1174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001176 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001177 * Enable support for PKCS#1 v2.1 encoding.
1178 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001179 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1180 *
1181 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1182 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001183 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001184 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001185 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001186 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1187 * this module in builds where MBEDTLS_MD_C is disabled.
1188 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001189 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001192
Steven Cooreman6801f082021-02-19 17:21:22 +01001193/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1194 *
1195 * Enable support for platform built-in keys. If you enable this feature,
1196 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1197 * See the documentation of that function for more information.
1198 *
1199 * Built-in keys are typically derived from a hardware unique key or
1200 * stored in a secure element.
1201 *
1202 * Requires: MBEDTLS_PSA_CRYPTO_C.
1203 *
1204 * \warning This interface is experimental and may change or be removed
1205 * without notice.
1206 */
1207//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1208
Ronald Cron3768ac12021-01-26 16:58:00 +01001209/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1210 *
1211 * Enable support for PSA crypto client.
1212 *
1213 * \note This option allows to include the code necessary for a PSA
1214 * crypto client when the PSA crypto implementation is not included in
1215 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1216 * code to set and get PSA key attributes.
1217 * The development of PSA drivers partially relying on the library to
1218 * fulfill the hardware gaps is another possible usage of this option.
1219 *
1220 * \warning This interface is experimental and may change or be removed
1221 * without notice.
1222 */
1223//#define MBEDTLS_PSA_CRYPTO_CLIENT
1224
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001225/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1226 *
1227 * Enable support for the experimental PSA crypto driver interface.
1228 *
John Durkop185764f2020-10-12 21:32:12 -07001229 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001230 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001231 * \warning This interface is experimental. We intend to maintain backward
1232 * compatibility with application code that relies on drivers,
1233 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001234 */
1235//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1236
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001237/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1238 *
1239 * Make the PSA Crypto module use an external random generator provided
1240 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1241 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001242 * \note This random generator must deliver random numbers with cryptographic
1243 * quality and high performance. It must supply unpredictable numbers
1244 * with a uniform distribution. The implementation of this function
1245 * is responsible for ensuring that the random generator is seeded
1246 * with sufficient entropy. If you have a hardware TRNG which is slow
1247 * or delivers non-uniform output, declare it as an entropy source
1248 * with mbedtls_entropy_add_source() instead of enabling this option.
1249 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001250 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001251 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1252 * and define a function called mbedtls_psa_external_get_random()
1253 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001254 * ```
1255 * psa_status_t mbedtls_psa_external_get_random(
1256 * mbedtls_psa_external_random_context_t *context,
1257 * uint8_t *output, size_t output_size, size_t *output_length);
1258 * );
1259 * ```
1260 * The \c context value is initialized to 0 before the first call.
1261 * The function must fill the \c output buffer with \p output_size bytes
1262 * of random data and set \c *output_length to \p output_size.
1263 *
1264 * Requires: MBEDTLS_PSA_CRYPTO_C
1265 *
1266 * \warning If you enable this option, code that uses the PSA cryptography
1267 * interface will not use any of the entropy sources set up for
1268 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1269 * enables.
1270 *
1271 * \note This option is experimental and may be removed without notice.
1272 */
1273//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1274
Paul Bakker9dcc3222011-03-08 14:16:06 +00001275/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001276 * \def MBEDTLS_PSA_CRYPTO_SPM
1277 *
1278 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1279 * Partition Manager) integration which separates the code into two parts: a
1280 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1281 * Environment).
1282 *
1283 * Module: library/psa_crypto.c
1284 * Requires: MBEDTLS_PSA_CRYPTO_C
1285 *
1286 */
1287//#define MBEDTLS_PSA_CRYPTO_SPM
1288
1289/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001290 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001291 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001292 * Enable support for entropy injection at first boot. This feature is
1293 * required on systems that do not have a built-in entropy source (TRNG).
1294 * This feature is currently not supported on systems that have a built-in
1295 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001296 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001297 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001298 *
1299 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001300//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001301
1302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001304 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001305 * Do not use the Chinese Remainder Theorem
1306 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001307 *
1308 * Uncomment this macro to disable the use of CRT in RSA.
1309 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001310 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001312
1313/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001315 *
1316 * Enable the checkup functions (*_self_test).
1317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001319
1320/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001321 * \def MBEDTLS_SHA256_SMALLER
1322 *
1323 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1324 * lower performance.
1325 *
Adam Wolf039080f2019-09-10 09:53:08 -05001326 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001327 * performance and size. This version optimizes more aggressively for size at
1328 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1329 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1330 * 30%.
1331 *
1332 * Uncomment to enable the smaller implementation of SHA256.
1333 */
1334//#define MBEDTLS_SHA256_SMALLER
1335
1336/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001337 * \def MBEDTLS_SHA512_SMALLER
1338 *
1339 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1340 * lower performance.
1341 *
1342 * Uncomment to enable the smaller implementation of SHA512.
1343 */
1344//#define MBEDTLS_SHA512_SMALLER
1345
1346/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001348 *
1349 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001350 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001351 * with other servers, only debugging of failures is harder.
1352 *
1353 * The advantage of not sending alert messages, is that no information is given
1354 * about reasons for failures thus preventing adversaries of gaining intel.
1355 *
1356 * Enable sending of all alert messages
1357 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001359
1360/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001361 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1362 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001363 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001364 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001365 * in the underlying transport. The CID functionality is described
1366 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001367 *
1368 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001369 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1370 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1371 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001372 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001373 * The maximum lengths of outgoing and incoming CIDs can be configured
1374 * through the options
1375 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1376 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1377 *
1378 * Requires: MBEDTLS_SSL_PROTO_DTLS
1379 *
1380 * Uncomment to enable the Connection ID extension.
1381 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001382#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1383
1384
1385/**
1386 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1387 *
1388 * Defines whether RFC 9146 (default) or the legacy version
1389 * (version draft-ietf-tls-dtls-connection-id-05,
1390 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1391 * is used.
1392 *
1393 * Set the value to 0 for the standard version, and
1394 * 1 for the legacy draft version.
1395 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001396 * \deprecated Support for the legacy version of the DTLS
1397 * Connection ID feature is deprecated. Please
1398 * switch to the standardized version defined
1399 * in RFC 9146 enabled by utilizing
1400 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1401 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1402 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001403 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1404 */
1405#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001406
1407/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001408 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1409 *
1410 * Enable asynchronous external private key operations in SSL. This allows
1411 * you to configure an SSL connection to call an external cryptographic
1412 * module to perform private key operations instead of performing the
1413 * operation inside the library.
1414 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001415 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001416 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001417//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001418
1419/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001420 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1421 *
1422 * Enable serialization of the TLS context structures, through use of the
1423 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1424 *
1425 * This pair of functions allows one side of a connection to serialize the
1426 * context associated with the connection, then free or re-use that context
1427 * while the serialized state is persisted elsewhere, and finally deserialize
1428 * that state to a live context for resuming read/write operations on the
1429 * connection. From a protocol perspective, the state of the connection is
1430 * unaffected, in particular this is entirely transparent to the peer.
1431 *
1432 * Note: this is distinct from TLS session resumption, which is part of the
1433 * protocol and fully visible by the peer. TLS session resumption enables
1434 * establishing new connections associated to a saved session with shorter,
1435 * lighter handshakes, while context serialization is a local optimization in
1436 * handling a single, potentially long-lived connection.
1437 *
1438 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1439 * saved after the handshake to allow for more efficient serialization, so if
1440 * you don't need this feature you'll save RAM by disabling it.
1441 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001442 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1443 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001444 * Comment to disable the context serialization APIs.
1445 */
1446#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1447
1448/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001449 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001450 *
1451 * Enable the debug messages in SSL module for all issues.
1452 * Debug messages have been disabled in some places to prevent timing
1453 * attacks due to (unbalanced) debugging function calls.
1454 *
1455 * If you need all error reporting you should enable this during debugging,
1456 * but remove this for production servers that should log as well.
1457 *
1458 * Uncomment this macro to report all debug messages on errors introducing
1459 * a timing side-channel.
1460 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001465 *
1466 * Enable support for Encrypt-then-MAC, RFC 7366.
1467 *
1468 * This allows peers that both support it to use a more robust protection for
1469 * ciphersuites using CBC, providing deep resistance against timing attacks
1470 * on the padding or underlying cipher.
1471 *
1472 * This only affects CBC ciphersuites, and is useless if none is defined.
1473 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001474 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001475 *
1476 * Comment this macro to disable support for Encrypt-then-MAC
1477 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001478#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001481 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001482 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1483 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001484 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001485 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001486 * attacks, but it is recommended to always use it (even if you disable
1487 * renegotiation), since it actually fixes a more fundamental issue in the
1488 * original SSL/TLS design, and has implications beyond Triple Handshake.
1489 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001490 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001491 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001492 * Comment this macro to disable support for Extended Master Secret.
1493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001495
Paul Bakkerd66f0702013-01-31 16:57:45 +01001496/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001497 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1498 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001499 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001500 * giving access to the peer's certificate after completion of the handshake.
1501 *
1502 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1503 * recommended to disable this option for reduced RAM usage.
1504 *
1505 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1506 * defined, but always returns \c NULL.
1507 *
1508 * \note This option has no influence on the protection against the
1509 * triple handshake attack. Even if it is disabled, Mbed TLS will
1510 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001511 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001512 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001513 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1514 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001515 * Comment this macro to disable storing the peer's certificate
1516 * after the handshake.
1517 */
1518#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1519
1520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001522 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001523 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001524 *
1525 * The two main uses of renegotiation are (1) refresh keys on long-lived
1526 * connections and (2) client authentication after the initial handshake.
1527 * If you don't need renegotiation, it's probably better to disable it, since
1528 * it has been associated with security issues in the past and is easy to
1529 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001530 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001531 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001532 *
1533 * \note Even if this option is disabled, both client and server are aware
1534 * of the Renegotiation Indication Extension (RFC 5746) used to
1535 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1536 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1537 * configuration of this extension).
1538 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001541
1542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001544 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001545 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001546 *
1547 * Comment this macro to disable support for the max_fragment_length extension
1548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001549#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001550
1551/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001553 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001554 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001555 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001556 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1557 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1558 * With MBEDTLS_USE_PSA_CRYPTO:
1559 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1560 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001561 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001562 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1563 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001564 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001565 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001568
1569/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001570 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001571 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001572 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001573 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001574 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1575 * pre-shared keys are not supported.
1576 * See docs/architecture/tls13-support.md for a description of the TLS
1577 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001578 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001579 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001580 * Requires: MBEDTLS_PSA_CRYPTO_C
1581 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001582 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1583 * directly performed by TLS 1.3 code. As a consequence, you must
1584 * call psa_crypto_init() before the first TLS 1.3 handshake.
1585 *
1586 * \note Cryptographic operations performed indirectly via another module
1587 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1588 * running handshake hash) only use PSA crypto if
1589 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001590 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001591 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001592 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001593//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001594
1595/**
Ronald Cronab65c522021-11-24 10:47:20 +01001596 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1597 *
1598 * Enable TLS 1.3 middlebox compatibility mode.
1599 *
1600 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1601 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1602 * expecting TLS 1.2 traffic.
1603 *
1604 * Turning on the compatibility mode comes at the cost of a few added bytes
1605 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1606 * that don't use it. Therefore, unless transmission bandwidth is critical and
1607 * you know that middlebox compatibility issues won't occur, it is therefore
1608 * recommended to set this option.
1609 *
1610 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001611 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1612 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001613 *
1614 */
1615//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1616
1617/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001618 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1619 *
1620 * Enable TLS 1.3 PSK key exchange mode.
1621 *
1622 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1623 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1624 * effect on the build.
1625 *
1626 */
1627#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1628
1629/**
1630 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1631 *
1632 * Enable TLS 1.3 ephemeral key exchange mode.
1633 *
1634 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1635 * MBEDTLS_PKCS1_V21
1636 *
1637 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1638 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1639 * effect on the build.
1640 *
1641 */
1642#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1643
1644/**
1645 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1646 *
1647 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1648 *
1649 * Requires: MBEDTLS_ECDH_C
1650 *
1651 * Comment to disable support for the PSK ephemeral key exchange mode in
1652 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1653 * have any effect on the build.
1654 *
1655 */
1656#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1657
1658/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 * \def MBEDTLS_SSL_EARLY_DATA
1660 *
1661 * Enable support for RFC 8446 TLS 1.3 early data.
1662 *
1663 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1664 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1665 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1666 *
1667 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1668 * is not enabled, this option does not have any effect on the build.
1669 *
1670 * This feature is experimental, not completed and thus not ready for
1671 * production.
1672 *
1673 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001674//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001675
1676/**
Jerry Yu16f68532022-11-05 10:50:06 +08001677 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1678 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001679 * The default maximum amount of 0-RTT data. See the documentation of
1680 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1681 *
1682 * It must be positive and smaller than UINT32_MAX.
1683 *
1684 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1685 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001686 *
1687 * This feature is experimental, not completed and thus not ready for
1688 * production.
1689 *
1690 */
1691#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1692
1693/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001695 *
1696 * Enable support for DTLS (all available versions).
1697 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001698 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001699 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001700 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001701 *
1702 * Comment this macro to disable support for DTLS
1703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001705
1706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001708 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001709 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001710 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001711 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001714
1715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001717 *
1718 * Enable support for the anti-replay mechanism in DTLS.
1719 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720 * Requires: MBEDTLS_SSL_TLS_C
1721 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001722 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001723 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001724 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001725 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001726 * Comment this to disable anti-replay in DTLS.
1727 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001729
1730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001731 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001732 *
1733 * Enable support for HelloVerifyRequest on DTLS servers.
1734 *
1735 * This feature is highly recommended to prevent DTLS servers being used as
1736 * amplifiers in DoS attacks against other hosts. It should always be enabled
1737 * unless you know for sure amplification cannot be a problem in the
1738 * environment in which your server operates.
1739 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001740 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001741 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001742 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001743 *
1744 * Comment this to disable support for HelloVerifyRequest.
1745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001747
1748/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001749 * \def MBEDTLS_SSL_DTLS_SRTP
1750 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001751 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001752 * through the use_srtp extension.
1753 *
1754 * \note This feature provides the minimum functionality required
1755 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1756 * the associated SRTP packet protection key material.
1757 * In particular, the SRTP packet protection itself, as well as the
1758 * demultiplexing of RTP and DTLS packets at the datagram layer
1759 * (see Section 5 of RFC 5764), are not handled by this feature.
1760 * Instead, after successful completion of a handshake negotiating
1761 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001762 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001763 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1764 * (this is implemented in the SSL example programs).
1765 * The resulting key should then be passed to an SRTP stack.
1766 *
1767 * Setting this option enables the runtime API
1768 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1769 * through which the supported DTLS-SRTP protection
1770 * profiles can be configured. You must call this API at
1771 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001772 *
1773 * Requires: MBEDTLS_SSL_PROTO_DTLS
1774 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001775 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001776 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001777//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001778
1779/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001780 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1781 *
1782 * Enable server-side support for clients that reconnect from the same port.
1783 *
1784 * Some clients unexpectedly close the connection and try to reconnect using the
1785 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001786 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001787 * flag enables that support.
1788 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001789 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001790 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001791 * Comment this to disable support for clients reusing the source port.
1792 */
1793#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1794
1795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001797 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001798 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001799 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001800 * session store remains the responsibility of the application, though).
1801 * Server-side, you also need to provide callbacks for writing and parsing
1802 * tickets, including authenticated encryption and key management. Example
1803 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001804 *
1805 * Comment this macro to disable support for SSL session tickets
1806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001812 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001815 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001816 * Comment this macro to disable support for server name indication in SSL
1817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001819
1820/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001821 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1822 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001823 * When this option is enabled, the SSL buffer will be resized automatically
1824 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001825 *
1826 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001827 */
1828//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1829
1830/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001831 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1832 *
1833 * Enable testing of the constant-flow nature of some sensitive functions with
1834 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001835 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001836 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001837 * This setting requires compiling with clang -fsanitize=memory. The test
1838 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001839 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001840 * \warning This macro is only used for extended testing; it is not considered
1841 * part of the library's API, so it may change or disappear at any time.
1842 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001843 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001844 */
1845//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1846
1847/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001848 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1849 *
1850 * Enable testing of the constant-flow nature of some sensitive functions with
1851 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001852 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001853 *
1854 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001855 * testing if the tests suites are run with valgrind's memcheck. This can be
1856 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1857 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001858 *
1859 * \warning This macro is only used for extended testing; it is not considered
1860 * part of the library's API, so it may change or disappear at any time.
1861 *
1862 * Uncomment to enable testing of the constant-flow nature of selected code.
1863 */
1864//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1865
1866/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001867 * \def MBEDTLS_TEST_HOOKS
1868 *
1869 * Enable features for invasive testing such as introspection functions and
1870 * hooks for fault injection. This enables additional unit tests.
1871 *
1872 * Merely enabling this feature should not change the behavior of the product.
1873 * It only adds new code, and new branching points where the default behavior
1874 * is the same as when this feature is disabled.
1875 * However, this feature increases the attack surface: there is an added
1876 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1877 * Therefore this feature must never be enabled in production.
1878 *
1879 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1880 * information.
1881 *
1882 * Uncomment to enable invasive tests.
1883 */
1884//#define MBEDTLS_TEST_HOOKS
1885
1886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001887 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001888 *
1889 * Provide your own alternate threading implementation.
1890 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001892 *
1893 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001894 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001896
1897/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001899 *
1900 * Enable the pthread wrapper layer for the threading layer.
1901 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001903 *
1904 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001905 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001906//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001907
1908/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001909 * \def MBEDTLS_USE_PSA_CRYPTO
1910 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001911 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1912 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001913 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001914 * \note Development of this option is currently in progress, and parts of Mbed
1915 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001916 * will still continue to work as usual, so enabling this option should not
1917 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001918 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001919 * \note See docs/use-psa-crypto.md for a complete description of what this
1920 * option currently does, and of parts that are not affected by it so far.
1921 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001922 * \warning If you enable this option, you need to call `psa_crypto_init()`
1923 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001924 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001925 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001926 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001927 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001928 */
1929//#define MBEDTLS_USE_PSA_CRYPTO
1930
1931/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001932 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1933 *
John Durkop185764f2020-10-12 21:32:12 -07001934 * This setting allows support for cryptographic mechanisms through the PSA
1935 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001936 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001937 * When this option is disabled, the PSA API exposes the cryptographic
1938 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1939 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001940 *
1941 * When this option is enabled, the PSA API exposes the cryptographic
1942 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1943 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1944 * automatically enabled if required (i.e. if no PSA driver provides the
1945 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1946 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001947 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001948 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001949 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001950 *
John Durkop185764f2020-10-12 21:32:12 -07001951 * This feature is still experimental and is not ready for production since
1952 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001953 */
1954//#define MBEDTLS_PSA_CRYPTO_CONFIG
1955
1956/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001958 *
1959 * Allow run-time checking of compile-time enabled features. Thus allowing users
1960 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001961 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001962 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001964 *
1965 * Comment this to disable run-time checking and save ROM space
1966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001968
1969/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001970 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1971 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001972 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001973 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1974 * the set of trusted certificates through a callback instead of a linked
1975 * list.
1976 *
1977 * This is useful for example in environments where a large number of trusted
1978 * certificates is present and storing them in a linked list isn't efficient
1979 * enough, or when the set of trusted certificates changes frequently.
1980 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001981 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001982 * `mbedtls_ssl_conf_ca_cb()` for more information.
1983 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01001984 * Requires: MBEDTLS_X509_CRT_PARSE_C
1985 *
Hanno Becker288dedc2019-03-27 11:00:53 +00001986 * Uncomment to enable trusted certificate callbacks.
1987 */
1988//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1989
1990/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001991 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001992 *
Chris Jones2c745862020-12-16 11:41:06 +00001993 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001994 *
Chris Jones2c745862020-12-16 11:41:06 +00001995 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001996 * and other functions/constants only used by these functions, thus reducing
1997 * the code footprint by several KB.
1998 */
Chris Jones2c745862020-12-16 11:41:06 +00001999//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002000
2001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002003 *
2004 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2005 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2006 *
2007 * Comment this macro to disallow using RSASSA-PSS in certificates.
2008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002010/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002011
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002012/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002013 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002014 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002015 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002016 * \{
2017 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002018
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002021 *
2022 * Enable AES-NI support on x86-64.
2023 *
2024 * Module: library/aesni.c
2025 * Caller: library/aes.c
2026 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002028 *
2029 * This modules adds support for the AES-NI instructions on x86-64
2030 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002032
2033/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002034 * \def MBEDTLS_AESCE_C
2035 *
Jerry Yu751e76b2023-02-16 10:48:15 +08002036 * Enable AES crypto extension support on Arm64.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002037 *
2038 * Module: library/aesce.c
2039 * Caller: library/aes.c
2040 *
2041 * Requires: MBEDTLS_HAVE_ASM, MBEDTLS_AES_C
2042 *
Jerry Yu330e6ae2023-02-21 14:51:38 +08002043 * \warning Runtime detection only works on linux. For non-linux operation
2044 * system, crypto extension MUST be supported by CPU.
2045 *
Jerry Yuc8bcdc82023-02-21 14:49:02 +08002046 * This module adds support for the AES crypto instructions on Arm64
Jerry Yu2fddfd72023-01-10 16:32:03 +08002047 */
2048#define MBEDTLS_AESCE_C
2049
2050/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002052 *
2053 * Enable the AES block cipher.
2054 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002055 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002056 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002057 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002058 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002059 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002060 * This module enables the following ciphersuites (if other requisites are
2061 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002062 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2063 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2064 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2065 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2066 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2067 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2068 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2069 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2070 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2071 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2072 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2073 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2075 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2076 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2077 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2078 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2079 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2080 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2081 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2082 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2083 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2084 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2085 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2087 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2088 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2089 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2090 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2091 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2092 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2093 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2094 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2095 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2096 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2097 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2098 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2099 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2100 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2101 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2102 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2103 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2104 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2105 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2106 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2107 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2108 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2109 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2110 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2111 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2112 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2113 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2114 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2115 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2116 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2117 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2118 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2119 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002120 *
Paul Bakkercff68422013-09-15 20:43:33 +02002121 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002124
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002126 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002127 *
2128 * Enable the generic ASN1 parser.
2129 *
2130 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002131 * Caller: library/x509.c
2132 * library/dhm.c
2133 * library/pkcs12.c
2134 * library/pkcs5.c
2135 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002138
2139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002141 *
2142 * Enable the generic ASN1 writer.
2143 *
2144 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002145 * Caller: library/ecdsa.c
2146 * library/pkwrite.c
2147 * library/x509_create.c
2148 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002149 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002152
2153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002155 *
2156 * Enable the Base64 module.
2157 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002158 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002159 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002160 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002161 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002162 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002164
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002165/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002167 *
Paul Bakker9a736322012-11-14 12:39:52 +00002168 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002169 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002171 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002172 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002173 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002175 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002176 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002177 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002178 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002179 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002180 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002181 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002182 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002184
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002185/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002187 *
2188 * Enable the Camellia block cipher.
2189 *
Paul Bakker38119b12009-01-10 23:31:23 +00002190 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002191 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002192 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002193 * This module enables the following ciphersuites (if other requisites are
2194 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002195 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2196 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2197 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2198 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2199 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2200 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2201 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2202 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2203 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2204 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2205 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2206 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2207 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2208 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2209 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2210 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2211 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2212 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2213 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2214 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2215 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2216 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2217 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2218 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2220 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2221 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2222 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2224 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2225 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2226 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2227 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2228 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2229 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2230 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2231 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2232 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2233 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2234 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2235 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2236 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002239
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002240/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002241 * \def MBEDTLS_ARIA_C
2242 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002243 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002244 *
2245 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002246 * Caller: library/cipher.c
2247 *
2248 * This module enables the following ciphersuites (if other requisites are
2249 * enabled as well):
2250 *
2251 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2252 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2253 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2254 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2255 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2256 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2257 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2258 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2259 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2260 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2261 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2262 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2263 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2264 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2265 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2266 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2267 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2268 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2269 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2270 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2271 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2272 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2273 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2274 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2275 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2276 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2277 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2278 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2279 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2280 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2282 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2283 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2284 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2288 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002289 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002290#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002291
2292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002294 *
2295 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2296 *
2297 * Module: library/ccm.c
2298 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002299 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2300 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002301 *
2302 * This module enables the AES-CCM ciphersuites, if other requisites are
2303 * enabled as well.
2304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002306
2307/**
Daniel King34b822c2016-05-15 17:28:08 -03002308 * \def MBEDTLS_CHACHA20_C
2309 *
2310 * Enable the ChaCha20 stream cipher.
2311 *
2312 * Module: library/chacha20.c
2313 */
2314#define MBEDTLS_CHACHA20_C
2315
2316/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002317 * \def MBEDTLS_CHACHAPOLY_C
2318 *
2319 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2320 *
2321 * Module: library/chachapoly.c
2322 *
2323 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2324 */
2325#define MBEDTLS_CHACHAPOLY_C
2326
2327/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002328 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002329 *
2330 * Enable the generic cipher layer.
2331 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002332 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002333 * Caller: library/ccm.c
2334 * library/cmac.c
2335 * library/gcm.c
2336 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002337 * library/pkcs12.c
2338 * library/pkcs5.c
2339 * library/psa_crypto_aead.c
2340 * library/psa_crypto_mac.c
2341 * library/ssl_ciphersuites.c
2342 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002343 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002344 *
2345 * Uncomment to enable generic cipher wrappers.
2346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002348
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002349/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002350 * \def MBEDTLS_CMAC_C
2351 *
Simon Butcher327398a2016-10-05 14:09:11 +01002352 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2353 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002354 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002355 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2356 * implementation of the CMAC algorithm is provided by an alternate
2357 * implementation, that alternate implementation may opt to not support
2358 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2359 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002360 * Module: library/cmac.c
2361 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002362 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002363 *
2364 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002365#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002366
2367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002369 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002370 * Enable the CTR_DRBG AES-based random generator.
2371 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002372 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002373 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002374 * \note To achieve a 256-bit security strength with CTR_DRBG,
2375 * you must use AES-256 *and* use sufficient entropy.
2376 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002377 *
2378 * Module: library/ctr_drbg.c
2379 * Caller:
2380 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002382 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002383 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002386
2387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002389 *
2390 * Enable the debug functions.
2391 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002393 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002395 * library/ssl_tls12_*.c
2396 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002397 *
2398 * This module provides debugging functions.
2399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002401
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002402/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002404 *
2405 * Enable the DES block cipher.
2406 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002407 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002408 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002409 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002410 *
Paul Bakkercff68422013-09-15 20:43:33 +02002411 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002412 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002413 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002414 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002417
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002420 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002421 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002422 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002423 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002424 * Caller: library/ssl_tls.c
2425 * library/ssl*_client.c
2426 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002428 * This module is used by the following key exchanges:
2429 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002430 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002431 * \warning Using DHE constitutes a security risk as it
2432 * is not possible to validate custom DH parameters.
2433 * If possible, it is recommended users should consider
2434 * preferring other methods of key exchange.
2435 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002436 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002439
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002440/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002442 *
2443 * Enable the elliptic curve Diffie-Hellman library.
2444 *
2445 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002446 * Caller: library/psa_crypto.c
2447 * library/ssl_tls.c
2448 * library/ssl*_client.c
2449 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002450 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002451 * This module is used by the following key exchanges:
2452 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002453 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002457
2458/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002459 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002460 *
2461 * Enable the elliptic curve DSA library.
2462 *
2463 * Module: library/ecdsa.c
2464 * Caller:
2465 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002466 * This module is used by the following key exchanges:
2467 * ECDHE-ECDSA
2468 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002469 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2470 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2471 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002473#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002474
2475/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002476 * \def MBEDTLS_ECJPAKE_C
2477 *
2478 * Enable the elliptic curve J-PAKE library.
2479 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002480 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2481 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002482 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002483 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002484 * Module: library/ecjpake.c
2485 * Caller:
2486 *
2487 * This module is used by the following key exchanges:
2488 * ECJPAKE
2489 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002490 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002491 *
2492 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2493 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002494 *
2495 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002496 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002497 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2498 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002499 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002500#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002501
2502/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002504 *
2505 * Enable the elliptic curve over GF(p) library.
2506 *
2507 * Module: library/ecp.c
2508 * Caller: library/ecdh.c
2509 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002510 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002515
2516/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002518 *
2519 * Enable the platform-specific entropy code.
2520 *
2521 * Module: library/entropy.c
2522 * Caller:
2523 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002525 *
2526 * This module provides a generic entropy pool
2527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002529
2530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002532 *
2533 * Enable error code to error string conversion.
2534 *
2535 * Module: library/error.c
2536 * Caller:
2537 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002541
2542/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002544 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002545 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002546 *
2547 * Module: library/gcm.c
2548 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002549 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2550 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002551 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002552 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2553 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002556
2557/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002558 * \def MBEDTLS_HKDF_C
2559 *
2560 * Enable the HKDF algorithm (RFC 5869).
2561 *
2562 * Module: library/hkdf.c
2563 * Caller:
2564 *
2565 * Requires: MBEDTLS_MD_C
2566 *
2567 * This module adds support for the Hashed Message Authentication Code
2568 * (HMAC)-based key derivation function (HKDF).
2569 */
2570#define MBEDTLS_HKDF_C
2571
2572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002574 *
2575 * Enable the HMAC_DRBG random generator.
2576 *
2577 * Module: library/hmac_drbg.c
2578 * Caller:
2579 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002581 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002582 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002585
2586/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002587 * \def MBEDTLS_LMS_C
2588 *
2589 * Enable the LMS stateful-hash asymmetric signature algorithm.
2590 *
2591 * Module: library/lms.c
2592 * Caller:
2593 *
Raef Colesab4f8742022-09-01 12:24:31 +01002594 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002595 *
Raef Colesab4f8742022-09-01 12:24:31 +01002596 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002597 */
2598#define MBEDTLS_LMS_C
2599
2600/**
Raef Colesab4f8742022-09-01 12:24:31 +01002601 * \def MBEDTLS_LMS_PRIVATE
2602 *
2603 * Enable LMS private-key operations and signing code. Functions enabled by this
2604 * option are experimental, and should not be used in production.
2605 *
2606 * Requires: MBEDTLS_LMS_C
2607 *
2608 * Uncomment to enable the LMS signature algorithm and private key operations.
2609 */
Raef Coles5127e852022-10-07 10:35:56 +01002610//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002611
2612/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002613 * \def MBEDTLS_NIST_KW_C
2614 *
2615 * Enable the Key Wrapping mode for 128-bit block ciphers,
2616 * as defined in NIST SP 800-38F. Only KW and KWP modes
2617 * are supported. At the moment, only AES is approved by NIST.
2618 *
2619 * Module: library/nist_kw.c
2620 *
2621 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2622 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002623#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002624
2625/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002627 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002628 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002629 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002630 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2631 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2632 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002633 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002634 * Caller: library/constant_time.c
2635 * library/ecdsa.c
2636 * library/ecjpake.c
2637 * library/hkdf.c
2638 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002639 * library/pk.c
2640 * library/pkcs5.c
2641 * library/pkcs12.c
2642 * library/psa_crypto_ecp.c
2643 * library/psa_crypto_rsa.c
2644 * library/rsa.c
2645 * library/ssl_cookie.c
2646 * library/ssl_msg.c
2647 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002648 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002649 * library/x509_crt.c
2650 * library/x509write_crt.c
2651 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002652 *
2653 * Uncomment to enable generic message digest wrappers.
2654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002656
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002657/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002658 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002659 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002660 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002661 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002662 * Module: library/md5.c
2663 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002664 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002665 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002666 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002667 * This module is required for TLS 1.2 depending on the handshake parameters.
2668 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2669 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002670 *
2671 * \warning MD5 is considered a weak message digest and its use constitutes a
2672 * security risk. If possible, we recommend avoiding dependencies on
2673 * it, and considering stronger message digests instead.
2674 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002677
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002680 *
2681 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002682 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002683 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002684 *
2685 * Module: library/memory_buffer_alloc.c
2686 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 * Requires: MBEDTLS_PLATFORM_C
2688 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002689 *
2690 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002693
2694/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002695 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002696 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002697 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2698 *
Simon Butcherd567a232016-03-09 20:19:21 +00002699 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2700 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002701 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002702 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002703 * \note See also our Knowledge Base article about porting to a new
2704 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002705 * 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 +00002706 *
Andres AG788aa4a2016-09-14 14:32:09 +01002707 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002708 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002709 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002711#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002712
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002714 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002715 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002716 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002717 *
2718 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002719 * Caller: library/asn1write.c
2720 * library/pkcs5.c
2721 * library/pkparse.c
2722 * library/pkwrite.c
2723 * library/rsa.c
2724 * library/x509.c
2725 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002726 * library/x509_crl.c
2727 * library/x509_crt.c
2728 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002729 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002730 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002731 *
2732 * This modules translates between OIDs and internal values.
2733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002735
2736/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002738 *
2739 * Enable VIA Padlock support on x86.
2740 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002741 * Module: library/padlock.c
2742 * Caller: library/aes.c
2743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002745 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002746 * This modules adds support for the VIA PadLock on x86.
2747 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002749
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002752 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002753 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002754 *
2755 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002756 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002757 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002758 * library/x509_crl.c
2759 * library/x509_crt.c
2760 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002761 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002762 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002763 *
Paul Bakkercff68422013-09-15 20:43:33 +02002764 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002765 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002767
2768/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002770 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002771 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002772 *
2773 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002774 * Caller: library/pkwrite.c
2775 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002776 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002777 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002779 *
2780 * This modules adds support for encoding / writing PEM files.
2781 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002783
2784/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002785 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002786 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002787 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002788 *
2789 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002790 * Caller: library/psa_crypto_rsa.c
2791 * library/ssl_tls.c
2792 * library/ssl*_client.c
2793 * library/ssl*_server.c
2794 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002795 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002796 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002797 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002798 * Uncomment to enable generic public key wrappers.
2799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002800#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002801
2802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002804 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002805 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002806 *
2807 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002808 * Caller: library/x509_crt.c
2809 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002812 *
2813 * Uncomment to enable generic public key parse functions.
2814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002816
2817/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002819 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002820 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002821 *
2822 * Module: library/pkwrite.c
2823 * Caller: library/x509write.c
2824 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002826 *
2827 * Uncomment to enable generic public key write functions.
2828 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002830
2831/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002833 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002834 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002835 *
2836 * Module: library/pkcs5.c
2837 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002838 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2839 *
2840 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2841 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002842 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002843 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002844 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002845 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2846 * this module in builds where MBEDTLS_MD_C is disabled.
2847 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002848 * This module adds support for the PKCS#5 functions.
2849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002851
2852/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002853 * \def MBEDTLS_PKCS7_C
2854 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002855 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002856 * RFC Link - https://tools.ietf.org/html/rfc2315
2857 *
2858 * Module: library/pkcs7.c
2859 *
2860 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002861 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2862 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002863 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002864 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002865 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002866#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002867
2868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002869 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002870 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002871 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002872 * Adds algorithms for parsing PKCS#8 encrypted private keys
2873 *
2874 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002875 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002876 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002877 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2878 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2879 *
2880 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2881 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002882 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002883 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002884 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002885 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2886 * this module in builds where MBEDTLS_MD_C is disabled.
2887 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002888 * This module enables PKCS#12 functions.
2889 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002891
2892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002894 *
2895 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002896 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2899 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002900 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002901 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002902 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002903 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002904 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002905 * Module: library/platform.c
2906 * Caller: Most other .c files
2907 *
2908 * This module enables abstraction of common (libc) functions.
2909 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002910#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002911
2912/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002913 * \def MBEDTLS_POLY1305_C
2914 *
2915 * Enable the Poly1305 MAC algorithm.
2916 *
2917 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002918 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002919 */
2920#define MBEDTLS_POLY1305_C
2921
2922/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002923 * \def MBEDTLS_PSA_CRYPTO_C
2924 *
2925 * Enable the Platform Security Architecture cryptography API.
2926 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002927 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002928 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002929 * Requires: MBEDTLS_CIPHER_C,
2930 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002931 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002932 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002933 *
2934 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002935#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002936
2937/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002938 * \def MBEDTLS_PSA_CRYPTO_SE_C
2939 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002940 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002941 * cryptography API.
2942 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002943 * \deprecated This feature is deprecated. Please switch to the driver
2944 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002945 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002946 * Module: library/psa_crypto_se.c
2947 *
2948 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2949 *
2950 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002951//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002952
2953/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002954 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2955 *
2956 * Enable the Platform Security Architecture persistent key storage.
2957 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002958 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002959 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002960 * Requires: MBEDTLS_PSA_CRYPTO_C,
2961 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2962 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002963 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002964#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002965
2966/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002967 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002968 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002969 * Enable the emulation of the Platform Security Architecture
2970 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002971 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002972 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002973 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002974 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002975 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002976#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002977
2978/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002980 *
2981 * Enable the RIPEMD-160 hash algorithm.
2982 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002983 * Module: library/ripemd160.c
2984 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002985 *
2986 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002988
2989/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002991 *
2992 * Enable the RSA public-key cryptosystem.
2993 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002994 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002995 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002996 * Caller: library/pk.c
2997 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002998 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002999 * library/ssl*_client.c
3000 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003001 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003002 * This module is used by the following key exchanges:
3003 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003004 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003008
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003011 *
3012 * Enable the SHA1 cryptographic hash algorithm.
3013 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003014 * Module: library/sha1.c
3015 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003016 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003017 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003018 * This module is required for TLS 1.2 depending on the handshake parameters,
3019 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003020 *
3021 * \warning SHA-1 is considered a weak message digest and its use constitutes
3022 * a security risk. If possible, we recommend avoiding dependencies
3023 * on it, and considering stronger message digests instead.
3024 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003027
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003028/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003029 * \def MBEDTLS_SHA224_C
3030 *
3031 * Enable the SHA-224 cryptographic hash algorithm.
3032 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003033 * Module: library/sha256.c
3034 * Caller: library/md.c
3035 * library/ssl_cookie.c
3036 *
3037 * This module adds support for SHA-224.
3038 */
3039#define MBEDTLS_SHA224_C
3040
3041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003043 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003044 * Enable the SHA-256 cryptographic hash algorithm.
3045 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003046 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003047 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003048 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003049 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003050 * library/ssl*_client.c
3051 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003052 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003053 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003054 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003057
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003058/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003059 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3060 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003061 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3062 * with the ARMv8 cryptographic extensions if they are available at runtime.
3063 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003064 *
3065 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3066 * for a non-Aarch64 build it will be silently ignored.
3067 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003068 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3069 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3070 *
3071 * Requires: MBEDTLS_SHA256_C.
3072 *
3073 * Module: library/sha256.c
3074 *
3075 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3076 * and use them if available.
3077 */
3078//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3079
3080/**
3081 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3082 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003083 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3084 * with the ARMv8 cryptographic extensions, which must be available at runtime
3085 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003086 *
3087 * \note This allows builds with a smaller code size than with
3088 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3089 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003090 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3091 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3092 *
3093 * Requires: MBEDTLS_SHA256_C.
3094 *
3095 * Module: library/sha256.c
3096 *
3097 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3098 * unconditionally.
3099 */
3100//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3101
3102/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003103 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003104 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003105 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003106 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003107 * Module: library/sha512.c
3108 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003109 * library/psa_crypto_hash.c
3110 * library/ssl_tls.c
3111 * library/ssl*_client.c
3112 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003113 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003114 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003115 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003116#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003117
3118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003120 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003121 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003122 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003123 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003124 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003125 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003126 * library/ssl_tls.c
3127 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003128 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003129 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003130 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003132
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003134 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3135 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003136 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3137 * with the ARMv8 cryptographic extensions if they are available at runtime.
3138 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003139 *
3140 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3141 * for a non-Aarch64 build it will be silently ignored.
3142 *
3143 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003144 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003145 *
3146 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3147 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3148 *
3149 * Requires: MBEDTLS_SHA512_C.
3150 *
3151 * Module: library/sha512.c
3152 *
3153 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3154 * and use them if available.
3155 */
3156//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3157
3158/**
3159 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3160 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003161 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3162 * with the ARMv8 cryptographic extensions, which must be available at runtime
3163 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003164 *
3165 * \note This allows builds with a smaller code size than with
3166 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3167 *
3168 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
Jerry Yuf7dccb32023-02-16 17:37:58 +08003169 * Clang >= 7.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003170 *
3171 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3172 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3173 *
3174 * Requires: MBEDTLS_SHA512_C.
3175 *
3176 * Module: library/sha512.c
3177 *
3178 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3179 * unconditionally.
3180 */
3181//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3182
3183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003185 *
3186 * Enable simple SSL cache implementation.
3187 *
3188 * Module: library/ssl_cache.c
3189 * Caller:
3190 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003191 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003194
3195/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003197 *
3198 * Enable basic implementation of DTLS cookies for hello verification.
3199 *
3200 * Module: library/ssl_cookie.c
3201 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003204
3205/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003206 * \def MBEDTLS_SSL_TICKET_C
3207 *
3208 * Enable an implementation of TLS server-side callbacks for session tickets.
3209 *
3210 * Module: library/ssl_ticket.c
3211 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003212 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003213 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3214 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003215 */
3216#define MBEDTLS_SSL_TICKET_C
3217
3218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003220 *
3221 * Enable the SSL/TLS client code.
3222 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003223 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003224 * Caller:
3225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003227 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003228 * This module is required for SSL/TLS client support.
3229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003231
Paul Bakker9a736322012-11-14 12:39:52 +00003232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003234 *
3235 * Enable the SSL/TLS server code.
3236 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003237 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003238 * Caller:
3239 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003241 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003242 * This module is required for SSL/TLS server support.
3243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003244#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003245
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003248 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003249 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003250 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003252 * Caller: library/ssl*_client.c
3253 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3256 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003257 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003258 * This module is required for SSL/TLS.
3259 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003261
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003264 *
3265 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003266 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003267 * contexts are not shared between threads. If you do intend to use contexts
3268 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003269 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003270 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003271 *
3272 * Module: library/threading.c
3273 *
3274 * This allows different threading implementations (self-implemented or
3275 * provided).
3276 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 * You will have to enable either MBEDTLS_THREADING_ALT or
3278 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003279 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003280 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003283
3284/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003286 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003287 * Enable the semi-portable timing interface.
3288 *
Simon Butcherd567a232016-03-09 20:19:21 +00003289 * \note The provided implementation only works on POSIX/Unix (including Linux,
3290 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003291 * module and provide your own implementations of the callbacks needed by
3292 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3293 * your own implementation of the whole module by setting
3294 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003295 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003296 * \note The timing module will include time.h on suitable platforms
3297 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3298 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3299 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003300 * \note See also our Knowledge Base article about porting to a new
3301 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003302 * 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 +00003303 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003304 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003307
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003308/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003310 *
3311 * Enable run-time version information.
3312 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003313 * Module: library/version.c
3314 *
3315 * This module provides run-time version information.
3316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003318
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003319/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003321 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003322 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003323 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003324 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003325 * Caller: library/x509_crl.c
3326 * library/x509_crt.c
3327 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003328 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003329 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003330 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3331 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003332 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3333 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003334 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003335 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003336 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003338
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003339/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003341 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003342 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003343 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003344 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003345 * Caller: library/ssl_tls.c
3346 * library/ssl*_client.c
3347 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003348 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003350 *
3351 * This module is required for X.509 certificate parsing.
3352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003354
3355/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357 *
3358 * Enable X.509 CRL parsing.
3359 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003360 * Module: library/x509_crl.c
3361 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003364 *
3365 * This module is required for X.509 CRL parsing.
3366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003368
3369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371 *
3372 * Enable X.509 Certificate Signing Request (CSR) parsing.
3373 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003374 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003375 * Caller: library/x509_crt_write.c
3376 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003378 *
3379 * This module is used for reading X.509 certificate request.
3380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003382
3383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003385 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003386 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003387 *
3388 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003389 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003390 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003391 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3392 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003393 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3394 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003395 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003396 * This module is the basis for creating X.509 certificates and CSRs.
3397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003399
3400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402 *
3403 * Enable creating X.509 certificates.
3404 *
3405 * Module: library/x509_crt_write.c
3406 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003408 *
3409 * This module is required for X.509 certificate creation.
3410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003412
3413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003415 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003416 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003417 *
3418 * Module: library/x509_csr_write.c
3419 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003421 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003422 * This module is required for X.509 certificate request writing.
3423 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003425
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003426/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003427
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003428/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003429 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003430 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003431 * This section contains Mbed TLS build settings that are not associated
3432 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003433 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003434 * \{
3435 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003436
Gilles Peskinea02c1242022-03-16 17:03:19 +01003437/**
3438 * \def MBEDTLS_CONFIG_FILE
3439 *
3440 * If defined, this is a header which will be included instead of
3441 * `"mbedtls/mbedtls_config.h"`.
3442 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003443 * Unlike other configuration options, this one must be defined on the
3444 * compiler command line: a definition in `mbedtls_config.h` would have
3445 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003446 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003447 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003448 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003449 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003450 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003451 * The value of this symbol is typically a path in double quotes, either
3452 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003453 */
3454//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3455
3456/**
3457 * \def MBEDTLS_USER_CONFIG_FILE
3458 *
3459 * If defined, this is a header which will be included after
3460 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003461 * This allows you to modify the default configuration, including the ability
3462 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003463 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003464 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003465 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003466 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003467 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003468 * The value of this symbol is typically a path in double quotes, either
3469 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003470 */
3471//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3472
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003473/**
3474 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3475 *
3476 * If defined, this is a header which will be included instead of
3477 * `"psa/crypto_config.h"`.
3478 * This header file specifies which cryptographic mechanisms are available
3479 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3480 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3481 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003482 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003483 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003484 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003485 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003486 * The value of this symbol is typically a path in double quotes, either
3487 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003488 */
3489//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3490
3491/**
3492 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3493 *
3494 * If defined, this is a header which will be included after
3495 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003496 * This allows you to modify the default configuration, including the ability
3497 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003498 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003499 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003500 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003501 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003502 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003503 * The value of this symbol is typically a path in double quotes, either
3504 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003505 */
3506//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3507
Gilles Peskineb1176f22023-02-22 22:07:28 +01003508/**
3509 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3510 *
3511 * If defined, this is a header which will be included instead of
3512 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3513 * as the one in Mbed TLS, but with definitions adapted to the platform on
3514 * which the library code will run.
3515 *
3516 * \note The required content of this header can vary from one version of
3517 * Mbed TLS to the next. Integrators who provide an alternative file
3518 * should review the changes in the original file whenever they
3519 * upgrade Mbed TLS.
3520 *
3521 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3522 * non-standard feature of the C language, so this feature is only available
3523 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3524 *
3525 * The value of this symbol is typically a path in double quotes, either
3526 * absolute or relative to a directory on the include search path.
3527 */
3528//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3529
3530/**
3531 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3532 *
3533 * If defined, this is a header which will be included instead of
3534 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3535 * as the one in Mbed TLS, but with definitions adapted to the environment
3536 * in which the library code will run. The typical use for this feature
3537 * is to provide alternative type definitions on the client side in
3538 * client-server integrations of PSA crypto, where operation structures
3539 * contain handles instead of cryptographic data.
3540 *
3541 * \note The required content of this header can vary from one version of
3542 * Mbed TLS to the next. Integrators who provide an alternative file
3543 * should review the changes in the original file whenever they
3544 * upgrade Mbed TLS.
3545 *
3546 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3547 * non-standard feature of the C language, so this feature is only available
3548 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3549 *
3550 * The value of this symbol is typically a path in double quotes, either
3551 * absolute or relative to a directory on the include search path.
3552 */
3553//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3554
Gilles Peskineba4162a2022-04-11 17:04:38 +02003555/** \} name SECTION: General configuration options */
3556
3557/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003558 * \name SECTION: Module configuration options
3559 *
3560 * This section allows for the setting of module specific sizes and
3561 * configuration options. The default values are already present in the
3562 * relevant header files and should suffice for the regular use cases.
3563 *
3564 * Our advice is to enable options and change their values here
3565 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003566 * \{
3567 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003568/* The Doxygen documentation here is used when a user comments out a
3569 * setting and runs doxygen themselves. On the other hand, when we typeset
3570 * the full documentation including disabled settings, the documentation
3571 * in specific modules' header files is used if present. When editing this
3572 * file, make sure that each option is documented in exactly one place,
3573 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3574 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003575
Paul Bakker088c5c52014-04-25 11:11:10 +02003576/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003577//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003579
Paul Bakker088c5c52014-04-25 11:11:10 +02003580/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3582//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3583//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3584//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3585//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003586
Paul Bakker088c5c52014-04-25 11:11:10 +02003587/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3589//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3590//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3591//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003592
Paul Bakker088c5c52014-04-25 11:11:10 +02003593/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003594//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003596
Paul Bakker088c5c52014-04-25 11:11:10 +02003597/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3599//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003600//#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 +01003601
Paul Bakker088c5c52014-04-25 11:11:10 +02003602/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003604
Paul Bakker088c5c52014-04-25 11:11:10 +02003605/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606//#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 +02003607//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003608//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003609//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003611//#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 +02003612//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3613//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003614/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003616//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3617//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003618//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3619//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3620//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3623/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003624//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3626//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003627//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003628//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3629//#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 +02003630//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3631//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003632/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003634//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003635//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3636//#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 +02003637
Gilles Peskine3f106f72021-09-23 17:42:39 +02003638/** \def MBEDTLS_CHECK_RETURN
3639 *
3640 * This macro is used at the beginning of the declaration of a function
3641 * to indicate that its return value should be checked. It should
3642 * instruct the compiler to emit a warning or an error if the function
3643 * is called without checking its return value.
3644 *
3645 * There is a default implementation for popular compilers in platform_util.h.
3646 * You can override the default implementation by defining your own here.
3647 *
3648 * If the implementation here is empty, this will effectively disable the
3649 * checking of functions' return values.
3650 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003651//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003652
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003653/** \def MBEDTLS_IGNORE_RETURN
3654 *
3655 * This macro requires one argument, which should be a C function call.
3656 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3657 * warning is suppressed.
3658 */
3659//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3660
Gilles Peskineed038902020-11-13 21:33:21 +01003661/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003662/**
Gilles Peskineed038902020-11-13 21:33:21 +01003663 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3664 * PSA crypto subsystem.
3665 *
3666 * If this option is unset:
3667 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003668 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003669 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3670 * on unspecified heuristics.
3671 */
3672//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3673
Steven Cooreman863470a2021-02-15 14:03:19 +01003674/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003675 * Restrict the PSA library to supporting a maximum amount of simultaneously
3676 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3677 * volatile key, or a persistent key which is loaded temporarily by the
3678 * library as part of a crypto operation in flight.
3679 *
3680 * If this option is unset, the library will fall back to a default value of
3681 * 32 keys.
3682 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003683//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003684
Paul Bakker088c5c52014-04-25 11:11:10 +02003685/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003686//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3687//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003688
Paul Bakker088c5c52014-04-25 11:11:10 +02003689/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003690
Angus Grattond8213d02016-05-25 20:56:48 +10003691/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3692 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003693 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003694 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003695 * This determines the size of the incoming TLS I/O buffer in such a way
3696 * that it is capable of holding the specified amount of plaintext data,
3697 * regardless of the protection mechanism used.
3698 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003699 * \note When using a value less than the default of 16KB on the client, it is
3700 * recommended to use the Maximum Fragment Length (MFL) extension to
3701 * inform the server about this limitation. On the server, there
3702 * is no supported, standardized way of informing the client about
3703 * restriction on the maximum size of incoming messages, and unless
3704 * the limitation has been communicated by other means, it is recommended
3705 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3706 * while keeping the default value of 16KB for the incoming buffer.
3707 *
David Horstmann95d516f2021-05-04 18:36:56 +01003708 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003709 */
3710//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3711
Gilles Peskined3d02902020-03-04 21:35:27 +01003712/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3713 *
3714 * The maximum length of CIDs used for incoming DTLS messages.
3715 *
3716 */
3717//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3718
3719/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3720 *
3721 * The maximum length of CIDs used for outgoing DTLS messages.
3722 *
3723 */
3724//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3725
TRodziewicze8dd7092021-05-12 14:19:11 +02003726/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003727 *
3728 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003729 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003730 *
3731 * The padding will always be chosen so that the length of the
3732 * padded plaintext is a multiple of the value of this option.
3733 *
3734 * Note: A value of \c 1 means that no padding will be used
3735 * for outgoing records.
3736 *
3737 * Note: On systems lacking division instructions,
3738 * a power of two should be preferred.
3739 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003740//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003741
Angus Grattond8213d02016-05-25 20:56:48 +10003742/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3743 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003744 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003745 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003746 * This determines the size of the outgoing TLS I/O buffer in such a way
3747 * that it is capable of holding the specified amount of plaintext data,
3748 * regardless of the protection mechanism used.
3749 *
Angus Grattond8213d02016-05-25 20:56:48 +10003750 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3751 * the default inward 16384 byte buffer to conform to the TLS specification.
3752 *
3753 * The minimum required outward buffer size is determined by the handshake
3754 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3755 * The specific size requirement depends on the configured ciphers and any
3756 * certificate data which is sent during the handshake.
3757 *
David Horstmann95d516f2021-05-04 18:36:56 +01003758 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003759 */
3760//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3761
Hanno Beckere0b150f2018-08-21 15:51:03 +01003762/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3763 *
3764 * Maximum number of heap-allocated bytes for the purpose of
3765 * DTLS handshake message reassembly and future message buffering.
3766 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003767 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003768 * to account for a reassembled handshake message of maximum size,
3769 * together with its reassembly bitmap.
3770 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003771 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003772 * should be sufficient for all practical situations as it allows
3773 * to reassembly a large handshake message (such as a certificate)
3774 * while buffering multiple smaller handshake messages.
3775 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003776 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003777//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003778
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003779//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3780//#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 +02003781
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003782/**
3783 * Complete list of ciphersuites to use, in order of preference.
3784 *
3785 * \warning No dependency checking is done on that field! This option can only
3786 * be used to restrict the set of available ciphersuites. It is your
3787 * responsibility to make sure the needed modules are active.
3788 *
3789 * Use this to save a few hundred bytes of ROM (default ordering of all
3790 * available ciphersuites) and a few to a few hundred bytes of RAM.
3791 *
3792 * The value below is only an example, not the default.
3793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#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 +02003795
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003796/**
3797 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3798 *
3799 * Maximum time difference in milliseconds tolerated between the age of a
3800 * ticket from the server and client point of view.
3801 * From the client point of view, the age of a ticket is the time difference
3802 * between the time when the client proposes to the server to use the ticket
3803 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3804 * the time the client received the ticket from the server.
3805 * From the server point of view, the age of a ticket is the time difference
3806 * between the time when the server receives a proposition from the client
3807 * to use the ticket and the time when the ticket was created by the server.
3808 * The server age is expected to be always greater than the client one and
3809 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3810 * maximum difference tolerated for the server to accept the ticket.
3811 * This is not used in TLS 1.2.
3812 *
3813 */
3814#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3815
3816/**
3817 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3818 *
3819 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3820 *
3821 * This must be less than 256.
3822 */
3823#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3824
3825/**
3826 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3827 *
3828 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3829 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3830 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3831 *
3832 */
3833#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3834
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003835/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003837//#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 +01003838
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003839/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003840 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003841 * mbedtls_platform_zeroize(). This replaces the default implementation in
3842 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003843 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003844 * mbedtls_platform_zeroize() is a widely used function across the library to
3845 * zero a block of memory. The implementation is expected to be secure in the
3846 * sense that it has been written to prevent the compiler from removing calls
3847 * to mbedtls_platform_zeroize() as part of redundant code elimination
3848 * optimizations. However, it is difficult to guarantee that calls to
3849 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3850 * versions of the C language standards do not provide a secure implementation
3851 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3852 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003853 * example by using directives specific to their compiler, features from newer
3854 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003855 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003856 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003857//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003858
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003859/**
3860 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003861 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003862 * platform_util.c.
3863 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003864 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003865 * library will try to use safer implementations of this function, such as
3866 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003867 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003868 * using the standard gmtime(). In this case, calls from the library to
3869 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003870 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003871 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003872 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3873 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3874 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003875 */
Hanno Becker6a739782018-09-05 15:06:19 +01003876//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003877
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003878/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003879 * Enable the verified implementations of ECDH primitives from Project Everest
3880 * (currently only Curve25519). This feature changes the layout of ECDH
3881 * contexts and therefore is a compatibility break for applications that access
3882 * fields of a mbedtls_ecdh_context structure directly. See also
3883 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003884 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003885//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003886
Gilles Peskine611179c2022-04-13 23:04:48 +02003887/** \} name SECTION: Module configuration options */