blob: 5d4033c1706b76b83f81f36f26d9ba7a34f86d40 [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:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010051 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000052 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000053 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010054 * Required by:
55 * MBEDTLS_AESNI_C
56 * MBEDTLS_PADLOCK_C
57 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020058 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000061
Paul Bakkerf3b86c12011-01-27 15:24:17 +000062/**
Gilles Peskineed942f82017-06-08 15:19:20 +020063 * \def MBEDTLS_NO_UDBL_DIVISION
64 *
65 * The platform lacks support for double-width integer division (64-bit
66 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
67 *
68 * Used in:
69 * include/mbedtls/bignum.h
70 * library/bignum.c
71 *
72 * The bignum code uses double-width division to speed up some operations.
73 * Double-width division is often implemented in software that needs to
74 * be linked with the program. The presence of a double-width integer
75 * type is usually detected automatically through preprocessor macros,
76 * but the automatic detection cannot know whether the code needs to
77 * and can be linked with an implementation of division for that type.
78 * By default division is assumed to be usable if the type is present.
79 * Uncomment this option to prevent the use of double-width division.
80 *
81 * Note that division for the native integer type is always required.
82 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010083 * platform, but it need not support multiplication or division. In some
84 * cases it is also desirable to disable some double-width operations. For
85 * example, if double-width division is implemented in software, disabling
86 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020087 */
88//#define MBEDTLS_NO_UDBL_DIVISION
89
90/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020091 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
92 *
93 * The platform lacks support for 32x32 -> 64-bit multiplication.
94 *
95 * Used in:
96 * library/poly1305.c
97 *
98 * Some parts of the library may use multiplication of two unsigned 32-bit
99 * operands with a 64-bit result in order to speed up computations. On some
100 * platforms, this is not available in hardware and has to be implemented in
101 * software, usually in a library provided by the toolchain.
102 *
103 * Sometimes it is not desirable to have to link to that library. This option
104 * removes the dependency of that library on platforms that lack a hardware
105 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
106 *
107 * Note that depending on the compiler, this may decrease performance compared
108 * to using the library function provided by the toolchain.
109 */
110//#define MBEDTLS_NO_64BIT_MULTIPLICATION
111
112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000114 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000115 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000116 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200120
121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200123 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200124 * System has time.h and time().
125 * The time does not need to be correct, only time differences are used,
126 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100128 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
129 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
130 * MBEDTLS_PLATFORM_STD_TIME.
131 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400132 * Comment if your system does not support time functions.
133 *
134 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
135 * interface - timing.c will include time.h on suitable platforms
136 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
137 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100140
141/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200142 * \def MBEDTLS_HAVE_TIME_DATE
143 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100144 * System has time.h, time(), and an implementation for
145 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100146 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200147 * the date should be correct). This is used to verify the validity period of
148 * X.509 certificates.
149 *
150 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100151 *
Hanno Becker6a739782018-09-05 15:06:19 +0100152 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100153 * behaves similarly to the gmtime_r() function from the C standard. Refer to
154 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100155 *
156 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100157 * mbedtls_platform_gmtime_r() at compile-time by using the macro
158 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200159 */
160#define MBEDTLS_HAVE_TIME_DATE
161
162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 *
165 * Enable the memory allocation layer.
166 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 * This allows different allocators (self-implemented or provided) to be
169 * provided to the platform abstraction layer.
170 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200172 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
173 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * free() function pointer at runtime.
175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200177 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181 *
182 * Enable this layer to allow use of alternative memory allocators.
183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185
186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200188 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200189 * Do not assign standard functions in the platform layer (e.g. calloc() to
190 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
192 * This makes sure there are no linking errors on platforms that do not support
193 * these functions. You will HAVE to provide alternatives, either at runtime
194 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
196 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200197 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200199 *
200 * Uncomment to prevent default assignment of standard functions in the
201 * platform layer.
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200204
205/**
Janos Follathc351d182016-03-21 08:43:59 +0000206 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100208 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
209 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
212 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100213 * alternative printf function pointer.
214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100216 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200217 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
218 * it will be enabled automatically by check_config.h
219 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200220 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000222 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100223 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
224 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100225 * Uncomment a macro to enable alternate implementation of specific base
226 * platform function
227 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200228//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100230//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231//#define MBEDTLS_PLATFORM_FPRINTF_ALT
232//#define MBEDTLS_PLATFORM_PRINTF_ALT
233//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200234//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100235//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100236//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100237
238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100240 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000241 * Mark deprecated functions and features so that they generate a warning if
242 * used. Functionality deprecated in one version will usually be removed in the
243 * next version. You can enable this to help you prepare the transition to a
244 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 *
246 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100252
253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000256 * Remove deprecated functions and features so that they generate an error if
257 * used. Functionality deprecated in one version will usually be removed in the
258 * next version. You can enable this to help you prepare the transition to a
259 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000261 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100264
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100265/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000266
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000267/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000268 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000269 *
270 * This section sets support for features that are or are not needed
271 * within the modules that are enabled.
272 * \{
273 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100277 *
TRodziewiczd8540832021-06-10 15:16:50 +0200278 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200279 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100282 *
283 * You will need to provide a header "timing_alt.h" and an implementation at
284 * compile time.
285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100287
288/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100289 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200290 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100291 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100292 * alternate core implementation of a symmetric crypto, an arithmetic or hash
293 * module (e.g. platform specific assembly optimized implementations). Keep
294 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200295 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200296 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000300 * provide the "struct mbedtls_aes_context" definition and omit the base
301 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200302 * "aes.h" to include the new function definitions.
303 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200304 * Uncomment a macro to enable alternate implementation of the corresponding
305 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100306 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200307 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100308 * use constitutes a security risk. If possible, we recommend
309 * avoiding dependencies on them, and considering stronger message
310 * digests and ciphers instead.
311 *
Paul Bakker90995b52013-06-24 19:20:35 +0200312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000314//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200316//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300317//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200318//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200319//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000321//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000322//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100323//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300324//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300326//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000328//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329//#define MBEDTLS_SHA1_ALT
330//#define MBEDTLS_SHA256_ALT
331//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000332
Janos Follathb0697532016-08-18 12:38:46 +0100333/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800334 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100335 * implemented with two .c files:
336 * - ecp.c
337 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000338 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
339 * macros as described above. The only difference is that you have to make sure
340 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100341 */
342//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200343
344/**
TRodziewicz75628d52021-06-18 12:56:27 +0200345 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200346 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100347 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
348 * alternate core implementation of symmetric crypto or hash function. Keep in
349 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200350 *
351 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200353 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
355 * no longer provide the mbedtls_sha1_process() function, but it will still provide
356 * the other function (using your mbedtls_sha1_process() function) and the definition
357 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 * with this definition.
359 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200360 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100361 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
362 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200363 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 * Uncomment a macro to enable alternate implementation of the corresponding
365 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100366 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200367 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100368 * constitutes a security risk. If possible, we recommend avoiding
369 * dependencies on them, and considering stronger message digests
370 * and ciphers instead.
371 *
Janos Follath1231d212019-01-07 15:01:32 +0000372 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
373 * enabled, then the deterministic ECDH signature functions pass the
374 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
375 * alternative implementations should use the RNG only for generating
376 * the ephemeral key and nothing else. If this is not possible, then
377 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200378 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000379 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381//#define MBEDTLS_MD5_PROCESS_ALT
382//#define MBEDTLS_RIPEMD160_PROCESS_ALT
383//#define MBEDTLS_SHA1_PROCESS_ALT
384//#define MBEDTLS_SHA256_PROCESS_ALT
385//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200386//#define MBEDTLS_DES_SETKEY_ALT
387//#define MBEDTLS_DES_CRYPT_ECB_ALT
388//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200389//#define MBEDTLS_AES_SETKEY_ENC_ALT
390//#define MBEDTLS_AES_SETKEY_DEC_ALT
391//#define MBEDTLS_AES_ENCRYPT_ALT
392//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300393//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300394//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300395//#define MBEDTLS_ECDSA_VERIFY_ALT
396//#define MBEDTLS_ECDSA_SIGN_ALT
397//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398
399/**
Janos Follathc44ab972016-11-18 16:38:23 +0000400 * \def MBEDTLS_ECP_INTERNAL_ALT
401 *
402 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100403 *
404 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100405 * alternative core implementation of elliptic curve arithmetic. Keep in mind
406 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100407 *
408 * This partially replaces one function. The header file from mbed TLS is still
409 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
410 * is still present and it is used for group structures not supported by the
411 * alternative.
412 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100413 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100414 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100415 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
416 * able to fallback to curves not supported by the alternative implementation.
417 *
Janos Follathc44ab972016-11-18 16:38:23 +0000418 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
419 * and implementing the following functions:
420 * unsigned char mbedtls_internal_ecp_grp_capable(
421 * const mbedtls_ecp_group *grp )
422 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500423 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000424 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
425 * replacement functions implement arithmetic for the given group and 0
426 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500427 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000428 * called before and after each point operation and provide an opportunity to
429 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100430 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100431 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
432 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
433 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
434 * for the operation is supported by your implementation (i.e. your
435 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
436 * group is not supported by your implementation, then the original mbed TLS
437 * implementation of ecp_double_jac() is used instead, unless this fallback
438 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
439 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
440 *
441 * The function prototypes and the definition of mbedtls_ecp_group and
442 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
443 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
444 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100445 *
446 * Uncomment a macro to enable alternate implementation of the corresponding
447 * function.
448 */
449/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000450//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100451/* Turn off software fallback for curves not supported in hardware */
452//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100453/* Support for Weierstrass curves with Jacobi representation */
454//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
455//#define MBEDTLS_ECP_ADD_MIXED_ALT
456//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
457//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
458//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
459/* Support for curves with Montgomery arithmetic */
460//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
461//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
462//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
463
464/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200465 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200466 *
467 * Uncomment this macro to let mbed TLS use your own implementation of a
468 * hardware entropy collector.
469 *
470 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000471 * prototype as declared in library/entropy_poll.h, and accept NULL as first
472 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200473 *
474 * Uncomment to use your own hardware entropy collector.
475 */
476//#define MBEDTLS_ENTROPY_HARDWARE_ALT
477
478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000480 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100481 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000482 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100483 * Uncomment this macro to use precomputed AES tables stored in ROM.
484 * Comment this macro to generate AES tables in RAM at runtime.
485 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100486 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
487 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100488 * initialization time before the first AES operation can be performed.
489 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
490 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
491 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100492 *
493 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
494 *
Paul Bakker15566e42011-04-24 21:19:15 +0000495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000497
498/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100499 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200500 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100501 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200502 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100503 * Uncommenting this macro omits 75% of the AES tables from
504 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
505 * by computing their values on the fly during operations
506 * (the tables are entry-wise rotations of one another).
507 *
508 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100509 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100510 * runtime. Specifically, one has to compare 4 accesses within
511 * different tables to 4 accesses with additional arithmetic
512 * operations within the same table. The performance gain/loss
513 * depends on the system and memory details.
514 *
515 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
516 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200517 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100518//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200519
520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200522 *
523 * Use less ROM for the Camellia implementation (saves about 768 bytes).
524 *
525 * Uncomment this macro to use less memory for Camellia.
526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200528
529/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200530 * \def MBEDTLS_CHECK_RETURN_WARNING
531 *
532 * If this macro is defined, emit a compile-time warning if application code
533 * calls a function without checking its return value, but the return value
534 * should generally be checked in portable applications.
535 *
536 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
537 * implemented. Otherwise this option has no effect.
538 *
539 * Uncomment to get warnings on using fallible functions without checking
540 * their return value.
541 *
542 * \note This feature is a work in progress.
543 * Warnings will be added to more functions in the future.
544 *
545 * \note A few functions are considered critical, and ignoring the return
546 * value of these functions will trigger a warning even if this
547 * macro is not defined. To completely disable return value check
548 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
549 */
550//#define MBEDTLS_CHECK_RETURN_WARNING
551
552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200554 *
555 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200558
559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000561 *
562 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000565
566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000568 *
569 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000572
573/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100574 * \def MBEDTLS_CIPHER_MODE_OFB
575 *
576 * Enable Output Feedback mode (OFB) for symmetric ciphers.
577 */
578#define MBEDTLS_CIPHER_MODE_OFB
579
580/**
581 * \def MBEDTLS_CIPHER_MODE_XTS
582 *
583 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
584 */
585#define MBEDTLS_CIPHER_MODE_XTS
586
587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589 *
590 * Enable NULL cipher.
591 * Warning: Only do so when you know what you are doing. This allows for
592 * encryption or channels without any security!
593 *
Ronald Croncee42702021-04-26 11:34:44 +0200594 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
596 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
597 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
598 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
599 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
600 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
601 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
602 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
603 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
604 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
605 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
606 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
607 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
608 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
609 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
610 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
611 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
612 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
613 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000614 *
615 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000618
619/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100620 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200621 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100622 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
623 * specific padding modes in the cipher layer with cipher modes that support
624 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200625 *
626 * If you disable all padding modes, only full blocks can be used with CBC.
627 *
628 * Enable padding modes in the cipher layer.
629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630#define MBEDTLS_CIPHER_PADDING_PKCS7
631#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
632#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
633#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200634
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200635/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
636 *
637 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
638 * By default, CTR_DRBG uses a 256-bit key.
639 */
640//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
641
Paul Bakker48e93c82013-08-14 12:21:18 +0200642/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100643 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200644 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100645 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
646 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200647 *
648 * Comment macros to disable the curve and functions for it
649 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200650/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
654#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
655#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
656#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
657#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
658#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
659#define MBEDTLS_ECP_DP_BP256R1_ENABLED
660#define MBEDTLS_ECP_DP_BP384R1_ENABLED
661#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200662/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200663#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000664#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200665
666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200668 *
669 * Enable specific 'modulo p' routines for each NIST prime.
670 * Depending on the prime and architecture, makes operations 4 to 8 times
671 * faster on the corresponding curve.
672 *
673 * Comment this macro to disable NIST curves optimisation.
674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200676
677/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200678 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100679 *
680 * Enable "non-blocking" ECC operations that can return early and be resumed.
681 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200682 * This allows various functions to pause by returning
683 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
684 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
685 * order to further progress and eventually complete their operation. This is
686 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
687 * number of ECC operations a function may perform before pausing; see
688 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100689 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200690 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200691 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100692 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100693 * This option:
694 * - Adds xxx_restartable() variants of existing operations in the
695 * following modules, with corresponding restart context types:
696 * - ECP: scalar multiplication (mult), linear combination (muladd);
697 * - ECDSA: signature generation & verification;
698 * - PK: signature generation & verification;
699 * - X509: certificate chain verification.
700 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
701 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
702 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
703 * computations restartable:
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100704 * - ECDH operations from the key exchange - unless MBEDTLS_USE_PSA_CRYPTO
705 * is also enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100706 * - verification of the server's key exchange signature;
707 * - verification of the server's certificate chain;
708 * - generation of our signature if client authentication is used, with an
709 * ECC key/certificate.
710 *
711 * \note In the cases above, the usual SSL/TLS functions, such as
712 * mbedtls_ssl_handshake(), can now return
713 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200714 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100715 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
716 * restartable operations in PK, X.509 and TLS (see above) are not
717 * using PSA. On the other hand, ECDH computations in TLS are using
718 * PSA, and are not restartable.
719 *
Ron Eldor19779c42018-11-05 16:58:13 +0200720 * \note This option only works with the default software implementation of
721 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100722 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100723 *
Manuel Pégourié-Gonnard57866462022-12-06 12:14:49 +0100724 * \note This option only works for Short Weierstrass curves.
725 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100726 * Requires: MBEDTLS_ECP_C
727 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100728 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100729 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200730//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100731
732/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100734 *
735 * Enable deterministic ECDSA (RFC 6979).
736 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
737 * may result in a compromise of the long-term signing key. This is avoided by
738 * the deterministic variant.
739 *
John Durkop36a82e52020-10-26 09:39:05 -0700740 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100741 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100742 * Comment this macro to disable deterministic ECDSA.
743 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100745
746/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200747 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200748 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200749 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200750 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200751 * This enables the following ciphersuites (if other requisites are
752 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
754 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
755 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
756 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
757 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
758 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
759 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
760 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
761 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
762 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200765
766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200767 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200769 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200770 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 *
773 * This enables the following ciphersuites (if other requisites are
774 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
776 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
778 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
779 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
781 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
782 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
783 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
784 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100785 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100786 * \warning Using DHE constitutes a security risk as it
787 * is not possible to validate custom DH parameters.
788 * If possible, it is recommended users should consider
789 * preferring other methods of key exchange.
790 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100791 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200794
795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200797 *
798 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
799 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 *
802 * This enables the following ciphersuites (if other requisites are
803 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
808 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
809 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200812
813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200816 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
819 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200820 *
821 * This enables the following ciphersuites (if other requisites are
822 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
824 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
826 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
827 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
829 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
830 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
831 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
832 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200835
836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200839 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200840 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200841 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
842 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200843 *
844 * This enables the following ciphersuites (if other requisites are
845 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
847 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
851 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
852 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
853 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
854 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
856 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
857 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200860
861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200864 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
867 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200868 *
869 * This enables the following ciphersuites (if other requisites are
870 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
878 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
881 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
882 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100883 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100884 * \warning Using DHE constitutes a security risk as it
885 * is not possible to validate custom DH parameters.
886 * If possible, it is recommended users should consider
887 * preferring other methods of key exchange.
888 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100889 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200892
893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200896 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200898 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
899 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200900 *
901 * This enables the following ciphersuites (if other requisites are
902 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
911 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
912 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200915
916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200918 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200919 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200920 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200922 *
923 * This enables the following ciphersuites (if other requisites are
924 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
933 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200937
938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200939 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100940 *
941 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
942 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200943 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100944 *
945 * This enables the following ciphersuites (if other requisites are
946 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100959
960/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100962 *
963 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
964 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200965 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100966 *
967 * This enables the following ciphersuites (if other requisites are
968 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200969 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
970 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
973 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
974 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
975 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
977 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
978 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200980#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100981
982/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200983 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
984 *
985 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
986 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200987 * \warning This is currently experimental. EC J-PAKE support is based on the
988 * Thread v1.0.0 specification; incompatible changes to the specification
989 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200990 *
991 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200992 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200993 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
994 *
995 * This enables the following ciphersuites (if other requisites are
996 * enabled as well):
997 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
998 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200999//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001000
1001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001003 *
1004 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1005 * RFC 5915 and RFC 5480.
1006 *
1007 * Currently this means parsing the SpecifiedECDomain choice of EC
1008 * parameters (only known groups are supported, not arbitrary domains, to
1009 * avoid validation issues).
1010 *
1011 * Disable if you only need to support RFC 5915 + 5480 key formats.
1012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001014
1015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001017 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * Enable a dummy error function to make use of mbedtls_strerror() in
1019 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1020 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001021 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1023 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001024 *
1025 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001029
1030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001032 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001033 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001038
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001041 *
1042 * Enable functions that use the filesystem.
1043 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001045
1046/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001048 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001049 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001050 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001051 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001052 * application.
1053 *
1054 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001055 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001056//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001057
1058/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001059 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001060 *
1061 * Do not use built-in platform entropy functions.
1062 * This is useful if your platform does not support
1063 * standards like the /dev/urandom or Windows CryptoAPI.
1064 *
1065 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001066 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001068
1069/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001070 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001071 *
1072 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1073 * default SHA-512 based one (if both are available).
1074 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001076 *
1077 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1078 * if you have performance concerns.
1079 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001080 * This option is only useful if both MBEDTLS_SHA256_C and
1081 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001084
1085/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001086 * \def MBEDTLS_ENTROPY_NV_SEED
1087 *
1088 * Enable the non-volatile (NV) seed file-based entropy source.
1089 * (Also enables the NV seed read/write functions in the platform layer)
1090 *
1091 * This is crucial (if not required) on systems that do not have a
1092 * cryptographic entropy source (in hardware or kernel) available.
1093 *
1094 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1095 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001096 * \note The read/write functions that are used by the entropy source are
1097 * determined in the platform layer, and can be modified at runtime and/or
1098 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1099 *
1100 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001101 * with regular fopen(), please make sure you make a seedfile with the
1102 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1103 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001104 * and written to or you will get an entropy source error! The default
1105 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1106 * bytes from the file.
1107 *
1108 * \note The entropy collector will write to the seed file before entropy is
1109 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001110 */
1111//#define MBEDTLS_ENTROPY_NV_SEED
1112
Ronald Cron71016a92020-08-28 19:01:50 +02001113/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001114 *
Ronald Cron71016a92020-08-28 19:01:50 +02001115 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001116 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001117 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1118 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001119 *
1120 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001121 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001122 */
Ronald Cron71016a92020-08-28 19:01:50 +02001123//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001124
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001127 *
1128 * Enable debugging of buffer allocator memory issues. Automatically prints
1129 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1130 * function for 'debug output' of allocated memory.
1131 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001133 *
1134 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001137
1138/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001140 *
1141 * Include backtrace information with each allocated block.
1142 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001143 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001144 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001145 *
1146 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001149
1150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001152 *
1153 * Support external private RSA keys (eg from a HSM) in the PK layer.
1154 *
1155 * Comment this macro to disable support for external private RSA keys.
1156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001158
1159/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001160 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001161 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001162 * Enable support for PKCS#1 v1.5 encoding.
1163 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001164 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001165 *
Paul Bakker48377d92013-08-30 12:06:24 +02001166 * This enables support for PKCS#1 v1.5 operations.
1167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001169
1170/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001172 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001173 * Enable support for PKCS#1 v2.1 encoding.
1174 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001175 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1176 *
1177 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1178 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001179 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001180 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001181 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001182 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1183 * this module in builds where MBEDTLS_MD_C is disabled.
1184 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001185 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1186 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001188
Steven Cooreman6801f082021-02-19 17:21:22 +01001189/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1190 *
1191 * Enable support for platform built-in keys. If you enable this feature,
1192 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1193 * See the documentation of that function for more information.
1194 *
1195 * Built-in keys are typically derived from a hardware unique key or
1196 * stored in a secure element.
1197 *
1198 * Requires: MBEDTLS_PSA_CRYPTO_C.
1199 *
1200 * \warning This interface is experimental and may change or be removed
1201 * without notice.
1202 */
1203//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1204
Ronald Cron3768ac12021-01-26 16:58:00 +01001205/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1206 *
1207 * Enable support for PSA crypto client.
1208 *
1209 * \note This option allows to include the code necessary for a PSA
1210 * crypto client when the PSA crypto implementation is not included in
1211 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1212 * code to set and get PSA key attributes.
1213 * The development of PSA drivers partially relying on the library to
1214 * fulfill the hardware gaps is another possible usage of this option.
1215 *
1216 * \warning This interface is experimental and may change or be removed
1217 * without notice.
1218 */
1219//#define MBEDTLS_PSA_CRYPTO_CLIENT
1220
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001221/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1222 *
1223 * Enable support for the experimental PSA crypto driver interface.
1224 *
John Durkop185764f2020-10-12 21:32:12 -07001225 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001226 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001227 * \warning This interface is experimental. We intend to maintain backward
1228 * compatibility with application code that relies on drivers,
1229 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001230 */
1231//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1232
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001233/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1234 *
1235 * Make the PSA Crypto module use an external random generator provided
1236 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1237 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001238 * \note This random generator must deliver random numbers with cryptographic
1239 * quality and high performance. It must supply unpredictable numbers
1240 * with a uniform distribution. The implementation of this function
1241 * is responsible for ensuring that the random generator is seeded
1242 * with sufficient entropy. If you have a hardware TRNG which is slow
1243 * or delivers non-uniform output, declare it as an entropy source
1244 * with mbedtls_entropy_add_source() instead of enabling this option.
1245 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001246 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001247 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1248 * and define a function called mbedtls_psa_external_get_random()
1249 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001250 * ```
1251 * psa_status_t mbedtls_psa_external_get_random(
1252 * mbedtls_psa_external_random_context_t *context,
1253 * uint8_t *output, size_t output_size, size_t *output_length);
1254 * );
1255 * ```
1256 * The \c context value is initialized to 0 before the first call.
1257 * The function must fill the \c output buffer with \p output_size bytes
1258 * of random data and set \c *output_length to \p output_size.
1259 *
1260 * Requires: MBEDTLS_PSA_CRYPTO_C
1261 *
1262 * \warning If you enable this option, code that uses the PSA cryptography
1263 * interface will not use any of the entropy sources set up for
1264 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1265 * enables.
1266 *
1267 * \note This option is experimental and may be removed without notice.
1268 */
1269//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1270
Paul Bakker9dcc3222011-03-08 14:16:06 +00001271/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001272 * \def MBEDTLS_PSA_CRYPTO_SPM
1273 *
1274 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1275 * Partition Manager) integration which separates the code into two parts: a
1276 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1277 * Environment).
1278 *
1279 * Module: library/psa_crypto.c
1280 * Requires: MBEDTLS_PSA_CRYPTO_C
1281 *
1282 */
1283//#define MBEDTLS_PSA_CRYPTO_SPM
1284
1285/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001288 * Enable support for entropy injection at first boot. This feature is
1289 * required on systems that do not have a built-in entropy source (TRNG).
1290 * This feature is currently not supported on systems that have a built-in
1291 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001293 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001294 *
1295 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001296//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001297
1298/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001300 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001301 * Do not use the Chinese Remainder Theorem
1302 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001303 *
1304 * Uncomment this macro to disable the use of CRT in RSA.
1305 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001308
1309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001311 *
1312 * Enable the checkup functions (*_self_test).
1313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001315
1316/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001317 * \def MBEDTLS_SHA256_SMALLER
1318 *
1319 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1320 * lower performance.
1321 *
Adam Wolf039080f2019-09-10 09:53:08 -05001322 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001323 * performance and size. This version optimizes more aggressively for size at
1324 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1325 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1326 * 30%.
1327 *
1328 * Uncomment to enable the smaller implementation of SHA256.
1329 */
1330//#define MBEDTLS_SHA256_SMALLER
1331
1332/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001333 * \def MBEDTLS_SHA512_SMALLER
1334 *
1335 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1336 * lower performance.
1337 *
1338 * Uncomment to enable the smaller implementation of SHA512.
1339 */
1340//#define MBEDTLS_SHA512_SMALLER
1341
1342/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001344 *
1345 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001346 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001347 * with other servers, only debugging of failures is harder.
1348 *
1349 * The advantage of not sending alert messages, is that no information is given
1350 * about reasons for failures thus preventing adversaries of gaining intel.
1351 *
1352 * Enable sending of all alert messages
1353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001355
1356/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001357 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1358 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001359 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001360 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001361 * in the underlying transport. The CID functionality is described
1362 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001363 *
1364 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001365 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1366 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1367 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001368 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001369 * The maximum lengths of outgoing and incoming CIDs can be configured
1370 * through the options
1371 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1372 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1373 *
1374 * Requires: MBEDTLS_SSL_PROTO_DTLS
1375 *
1376 * Uncomment to enable the Connection ID extension.
1377 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001378#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1379
1380
1381/**
1382 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1383 *
1384 * Defines whether RFC 9146 (default) or the legacy version
1385 * (version draft-ietf-tls-dtls-connection-id-05,
1386 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1387 * is used.
1388 *
1389 * Set the value to 0 for the standard version, and
1390 * 1 for the legacy draft version.
1391 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001392 * \deprecated Support for the legacy version of the DTLS
1393 * Connection ID feature is deprecated. Please
1394 * switch to the standardized version defined
1395 * in RFC 9146 enabled by utilizing
1396 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1397 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1398 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001399 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1400 */
1401#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001402
1403/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001404 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1405 *
1406 * Enable asynchronous external private key operations in SSL. This allows
1407 * you to configure an SSL connection to call an external cryptographic
1408 * module to perform private key operations instead of performing the
1409 * operation inside the library.
1410 *
1411 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001412//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001413
1414/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001415 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1416 *
1417 * Enable serialization of the TLS context structures, through use of the
1418 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1419 *
1420 * This pair of functions allows one side of a connection to serialize the
1421 * context associated with the connection, then free or re-use that context
1422 * while the serialized state is persisted elsewhere, and finally deserialize
1423 * that state to a live context for resuming read/write operations on the
1424 * connection. From a protocol perspective, the state of the connection is
1425 * unaffected, in particular this is entirely transparent to the peer.
1426 *
1427 * Note: this is distinct from TLS session resumption, which is part of the
1428 * protocol and fully visible by the peer. TLS session resumption enables
1429 * establishing new connections associated to a saved session with shorter,
1430 * lighter handshakes, while context serialization is a local optimization in
1431 * handling a single, potentially long-lived connection.
1432 *
1433 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1434 * saved after the handshake to allow for more efficient serialization, so if
1435 * you don't need this feature you'll save RAM by disabling it.
1436 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001437 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1438 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001439 * Comment to disable the context serialization APIs.
1440 */
1441#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1442
1443/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001445 *
1446 * Enable the debug messages in SSL module for all issues.
1447 * Debug messages have been disabled in some places to prevent timing
1448 * attacks due to (unbalanced) debugging function calls.
1449 *
1450 * If you need all error reporting you should enable this during debugging,
1451 * but remove this for production servers that should log as well.
1452 *
1453 * Uncomment this macro to report all debug messages on errors introducing
1454 * a timing side-channel.
1455 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001456 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001458
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001460 *
1461 * Enable support for Encrypt-then-MAC, RFC 7366.
1462 *
1463 * This allows peers that both support it to use a more robust protection for
1464 * ciphersuites using CBC, providing deep resistance against timing attacks
1465 * on the padding or underlying cipher.
1466 *
1467 * This only affects CBC ciphersuites, and is useless if none is defined.
1468 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001469 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001470 *
1471 * Comment this macro to disable support for Encrypt-then-MAC
1472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001474
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001476 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001477 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1478 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001479 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001480 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001481 * attacks, but it is recommended to always use it (even if you disable
1482 * renegotiation), since it actually fixes a more fundamental issue in the
1483 * original SSL/TLS design, and has implications beyond Triple Handshake.
1484 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001485 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001486 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001487 * Comment this macro to disable support for Extended Master Secret.
1488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001489#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001490
Paul Bakkerd66f0702013-01-31 16:57:45 +01001491/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001492 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1493 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001494 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001495 * giving access to the peer's certificate after completion of the handshake.
1496 *
1497 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1498 * recommended to disable this option for reduced RAM usage.
1499 *
1500 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1501 * defined, but always returns \c NULL.
1502 *
1503 * \note This option has no influence on the protection against the
1504 * triple handshake attack. Even if it is disabled, Mbed TLS will
1505 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001506 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001507 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001508 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1509 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001510 * Comment this macro to disable storing the peer's certificate
1511 * after the handshake.
1512 */
1513#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1514
1515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001517 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001518 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001519 *
1520 * The two main uses of renegotiation are (1) refresh keys on long-lived
1521 * connections and (2) client authentication after the initial handshake.
1522 * If you don't need renegotiation, it's probably better to disable it, since
1523 * it has been associated with security issues in the past and is easy to
1524 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001525 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001526 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001527 *
1528 * \note Even if this option is disabled, both client and server are aware
1529 * of the Renegotiation Indication Extension (RFC 5746) used to
1530 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1531 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1532 * configuration of this extension).
1533 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001536
1537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001539 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001540 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001541 *
1542 * Comment this macro to disable support for the max_fragment_length extension
1543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001545
1546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001547 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001548 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001549 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001550 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001551 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1552 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1553 * With MBEDTLS_USE_PSA_CRYPTO:
1554 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1555 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001556 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001557 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1558 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001559 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001560 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001561 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001562#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001563
1564/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001565 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001566 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001567 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001568 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001569 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1570 * pre-shared keys are not supported.
1571 * See docs/architecture/tls13-support.md for a description of the TLS
1572 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001573 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001574 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001575 * Requires: MBEDTLS_PSA_CRYPTO_C
1576 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001577 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1578 * for most operations, if you want it to only use PSA for all crypto
1579 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1580 * operations, and functions that are common with TLS 1.2 (record protection,
1581 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001582 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001583 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001584 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001585//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001586
1587/**
Ronald Cronab65c522021-11-24 10:47:20 +01001588 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1589 *
1590 * Enable TLS 1.3 middlebox compatibility mode.
1591 *
1592 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1593 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1594 * expecting TLS 1.2 traffic.
1595 *
1596 * Turning on the compatibility mode comes at the cost of a few added bytes
1597 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1598 * that don't use it. Therefore, unless transmission bandwidth is critical and
1599 * you know that middlebox compatibility issues won't occur, it is therefore
1600 * recommended to set this option.
1601 *
1602 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001603 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1604 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001605 *
1606 */
1607//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1608
1609/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001610 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1611 *
1612 * Enable TLS 1.3 PSK key exchange mode.
1613 *
1614 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1615 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1616 * effect on the build.
1617 *
1618 */
1619#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1620
1621/**
1622 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1623 *
1624 * Enable TLS 1.3 ephemeral key exchange mode.
1625 *
1626 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1627 * MBEDTLS_PKCS1_V21
1628 *
1629 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1630 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1631 * effect on the build.
1632 *
1633 */
1634#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1635
1636/**
1637 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1638 *
1639 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1640 *
1641 * Requires: MBEDTLS_ECDH_C
1642 *
1643 * Comment to disable support for the PSK ephemeral key exchange mode in
1644 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1645 * have any effect on the build.
1646 *
1647 */
1648#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1649
1650/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001651 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001652 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001653 * Maximum time difference in milliseconds tolerated between the age of a
1654 * ticket from the server and client point of view.
1655 * From the client point of view, the age of a ticket is the time difference
1656 * between the time when the client proposes to the server to use the ticket
1657 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1658 * the time the client received the ticket from the server.
1659 * From the server point of view, the age of a ticket is the time difference
1660 * between the time when the server receives a proposition from the client
1661 * to use the ticket and the time when the ticket was created by the server.
1662 * The server age is expected to be always greater than the client one and
1663 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1664 * maximum difference tolerated for the server to accept the ticket.
1665 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001666 *
1667 */
1668#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1669
1670/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001671 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1672 *
1673 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1674 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001675 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001676 */
Jerry Yu9750f812022-07-20 11:04:50 +08001677#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001678
1679/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001680 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1681 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001682 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1683 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1684 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001685 *
1686 */
1687#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1688
1689/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001690* \def MBEDTLS_SSL_EARLY_DATA
1691*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001692* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001693*
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001694* Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1695* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1696* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001697*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001698* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001699* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001700*
1701* This feature is experimental, not completed and thus not ready for
1702* production.
1703*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001704*/
Ronald Cronc2e110f2022-11-22 09:01:46 +01001705//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001709 *
1710 * Enable support for DTLS (all available versions).
1711 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001714 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001715 *
1716 * Comment this macro to disable support for DTLS
1717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001719
1720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001722 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001723 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001725 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001728
1729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 *
1732 * Enable support for the anti-replay mechanism in DTLS.
1733 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734 * Requires: MBEDTLS_SSL_TLS_C
1735 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001736 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001738 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001739 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001740 * Comment this to disable anti-replay in DTLS.
1741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001742#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001743
1744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001745 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001746 *
1747 * Enable support for HelloVerifyRequest on DTLS servers.
1748 *
1749 * This feature is highly recommended to prevent DTLS servers being used as
1750 * amplifiers in DoS attacks against other hosts. It should always be enabled
1751 * unless you know for sure amplification cannot be a problem in the
1752 * environment in which your server operates.
1753 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001754 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001755 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001756 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001757 *
1758 * Comment this to disable support for HelloVerifyRequest.
1759 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001761
1762/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001763 * \def MBEDTLS_SSL_DTLS_SRTP
1764 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001765 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001766 * through the use_srtp extension.
1767 *
1768 * \note This feature provides the minimum functionality required
1769 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1770 * the associated SRTP packet protection key material.
1771 * In particular, the SRTP packet protection itself, as well as the
1772 * demultiplexing of RTP and DTLS packets at the datagram layer
1773 * (see Section 5 of RFC 5764), are not handled by this feature.
1774 * Instead, after successful completion of a handshake negotiating
1775 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001776 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001777 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1778 * (this is implemented in the SSL example programs).
1779 * The resulting key should then be passed to an SRTP stack.
1780 *
1781 * Setting this option enables the runtime API
1782 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1783 * through which the supported DTLS-SRTP protection
1784 * profiles can be configured. You must call this API at
1785 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001786 *
1787 * Requires: MBEDTLS_SSL_PROTO_DTLS
1788 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001789 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001790 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001791//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001792
1793/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001794 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1795 *
1796 * Enable server-side support for clients that reconnect from the same port.
1797 *
1798 * Some clients unexpectedly close the connection and try to reconnect using the
1799 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001800 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001801 * flag enables that support.
1802 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001803 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001804 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001805 * Comment this to disable support for clients reusing the source port.
1806 */
1807#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1808
1809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001810 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001811 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001812 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001813 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001814 * session store remains the responsibility of the application, though).
1815 * Server-side, you also need to provide callbacks for writing and parsing
1816 * tickets, including authenticated encryption and key management. Example
1817 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001818 *
1819 * Comment this macro to disable support for SSL session tickets
1820 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001822
1823/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001826 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001827 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001828 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001829 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001830 * Comment this macro to disable support for server name indication in SSL
1831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001832#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001833
1834/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001835 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1836 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001837 * When this option is enabled, the SSL buffer will be resized automatically
1838 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001839 *
1840 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001841 */
1842//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1843
1844/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001845 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1846 *
1847 * Enable testing of the constant-flow nature of some sensitive functions with
1848 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001849 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001850 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001851 * This setting requires compiling with clang -fsanitize=memory. The test
1852 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001853 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001854 * \warning This macro is only used for extended testing; it is not considered
1855 * part of the library's API, so it may change or disappear at any time.
1856 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001857 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001858 */
1859//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1860
1861/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001862 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1863 *
1864 * Enable testing of the constant-flow nature of some sensitive functions with
1865 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001866 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001867 *
1868 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001869 * testing if the tests suites are run with valgrind's memcheck. This can be
1870 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1871 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001872 *
1873 * \warning This macro is only used for extended testing; it is not considered
1874 * part of the library's API, so it may change or disappear at any time.
1875 *
1876 * Uncomment to enable testing of the constant-flow nature of selected code.
1877 */
1878//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1879
1880/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001881 * \def MBEDTLS_TEST_HOOKS
1882 *
1883 * Enable features for invasive testing such as introspection functions and
1884 * hooks for fault injection. This enables additional unit tests.
1885 *
1886 * Merely enabling this feature should not change the behavior of the product.
1887 * It only adds new code, and new branching points where the default behavior
1888 * is the same as when this feature is disabled.
1889 * However, this feature increases the attack surface: there is an added
1890 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1891 * Therefore this feature must never be enabled in production.
1892 *
1893 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1894 * information.
1895 *
1896 * Uncomment to enable invasive tests.
1897 */
1898//#define MBEDTLS_TEST_HOOKS
1899
1900/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001902 *
1903 * Provide your own alternate threading implementation.
1904 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001906 *
1907 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001910
1911/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001913 *
1914 * Enable the pthread wrapper layer for the threading layer.
1915 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001916 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001917 *
1918 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001919 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001921
1922/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001923 * \def MBEDTLS_USE_PSA_CRYPTO
1924 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001925 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1926 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001927 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001928 * \note Development of this option is currently in progress, and parts of Mbed
1929 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001930 * will still continue to work as usual, so enabling this option should not
1931 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001932 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001933 * \note See docs/use-psa-crypto.md for a complete description of what this
1934 * option currently does, and of parts that are not affected by it so far.
1935 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001936 * \warning If you enable this option, you need to call `psa_crypto_init()`
1937 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001938 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001939 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001940 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001941 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001942 */
1943//#define MBEDTLS_USE_PSA_CRYPTO
1944
1945/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001946 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1947 *
John Durkop185764f2020-10-12 21:32:12 -07001948 * This setting allows support for cryptographic mechanisms through the PSA
1949 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001950 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001951 * When this option is disabled, the PSA API exposes the cryptographic
1952 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1953 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001954 *
1955 * When this option is enabled, the PSA API exposes the cryptographic
1956 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1957 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1958 * automatically enabled if required (i.e. if no PSA driver provides the
1959 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1960 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001961 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001962 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001963 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001964 *
John Durkop185764f2020-10-12 21:32:12 -07001965 * This feature is still experimental and is not ready for production since
1966 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001967 */
1968//#define MBEDTLS_PSA_CRYPTO_CONFIG
1969
1970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001972 *
1973 * Allow run-time checking of compile-time enabled features. Thus allowing users
1974 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001978 *
1979 * Comment this to disable run-time checking and save ROM space
1980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001982
1983/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001984 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1985 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001986 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001987 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1988 * the set of trusted certificates through a callback instead of a linked
1989 * list.
1990 *
1991 * This is useful for example in environments where a large number of trusted
1992 * certificates is present and storing them in a linked list isn't efficient
1993 * enough, or when the set of trusted certificates changes frequently.
1994 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001995 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001996 * `mbedtls_ssl_conf_ca_cb()` for more information.
1997 *
1998 * Uncomment to enable trusted certificate callbacks.
1999 */
2000//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2001
2002/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002003 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002004 *
Chris Jones2c745862020-12-16 11:41:06 +00002005 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002006 *
Chris Jones2c745862020-12-16 11:41:06 +00002007 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002008 * and other functions/constants only used by these functions, thus reducing
2009 * the code footprint by several KB.
2010 */
Chris Jones2c745862020-12-16 11:41:06 +00002011//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002012
2013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002015 *
2016 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2017 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2018 *
2019 * Comment this macro to disallow using RSASSA-PSS in certificates.
2020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002022/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002023
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002024/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002025 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002026 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002027 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002028 * \{
2029 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002030
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002031/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002033 *
2034 * Enable AES-NI support on x86-64.
2035 *
2036 * Module: library/aesni.c
2037 * Caller: library/aes.c
2038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002040 *
2041 * This modules adds support for the AES-NI instructions on x86-64
2042 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002044
2045/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002047 *
2048 * Enable the AES block cipher.
2049 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002050 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002051 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002052 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002053 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002054 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002055 * This module enables the following ciphersuites (if other requisites are
2056 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2058 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2059 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2060 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2061 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2062 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2063 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2064 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2065 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2066 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2067 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2068 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2069 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2070 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2071 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2072 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2073 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2074 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2075 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2076 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2077 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2078 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2079 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2080 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2081 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2082 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2083 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2084 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2085 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2086 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2087 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2088 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2089 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2090 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2091 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2092 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2093 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2094 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2095 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2096 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2097 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2098 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2099 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2100 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2101 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2102 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2103 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2104 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2105 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2106 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2107 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2108 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2109 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2110 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2111 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2112 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2113 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2114 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002115 *
Paul Bakkercff68422013-09-15 20:43:33 +02002116 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002118#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002119
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002120/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002122 *
2123 * Enable the generic ASN1 parser.
2124 *
2125 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002126 * Caller: library/x509.c
2127 * library/dhm.c
2128 * library/pkcs12.c
2129 * library/pkcs5.c
2130 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002133
2134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002136 *
2137 * Enable the generic ASN1 writer.
2138 *
2139 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002140 * Caller: library/ecdsa.c
2141 * library/pkwrite.c
2142 * library/x509_create.c
2143 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002144 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002145 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002147
2148/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002150 *
2151 * Enable the Base64 module.
2152 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002153 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002154 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002155 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002156 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002159
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002160/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002161 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002162 *
Paul Bakker9a736322012-11-14 12:39:52 +00002163 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002164 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002165 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002166 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002167 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002168 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002170 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002171 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002173 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002175 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002176 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002178#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002179
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002181 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002182 *
2183 * Enable the Camellia block cipher.
2184 *
Paul Bakker38119b12009-01-10 23:31:23 +00002185 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002186 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002187 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002188 * This module enables the following ciphersuites (if other requisites are
2189 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2191 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2192 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2193 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2194 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2195 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2196 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2197 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2198 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2199 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2200 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2201 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2202 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2203 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2204 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2205 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2206 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2207 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2208 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2209 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2210 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2211 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2212 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2213 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2214 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2215 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2216 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2217 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2219 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2221 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2222 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2224 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2225 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2226 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2227 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2228 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2229 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2230 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2231 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002232 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002234
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002235/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002236 * \def MBEDTLS_ARIA_C
2237 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002238 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002239 *
2240 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002241 * Caller: library/cipher.c
2242 *
2243 * This module enables the following ciphersuites (if other requisites are
2244 * enabled as well):
2245 *
2246 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2248 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2249 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2250 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2251 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2252 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2255 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2257 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2258 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2259 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2262 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2265 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2266 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2267 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2268 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2269 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2270 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2271 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2272 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2274 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2276 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2277 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2278 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2279 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2281 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2282 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2283 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002284 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002285#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002286
2287/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002288 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002289 *
2290 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2291 *
2292 * Module: library/ccm.c
2293 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002294 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2295 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002296 *
2297 * This module enables the AES-CCM ciphersuites, if other requisites are
2298 * enabled as well.
2299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002301
2302/**
Daniel King34b822c2016-05-15 17:28:08 -03002303 * \def MBEDTLS_CHACHA20_C
2304 *
2305 * Enable the ChaCha20 stream cipher.
2306 *
2307 * Module: library/chacha20.c
2308 */
2309#define MBEDTLS_CHACHA20_C
2310
2311/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002312 * \def MBEDTLS_CHACHAPOLY_C
2313 *
2314 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2315 *
2316 * Module: library/chachapoly.c
2317 *
2318 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2319 */
2320#define MBEDTLS_CHACHAPOLY_C
2321
2322/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002324 *
2325 * Enable the generic cipher layer.
2326 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002327 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002328 * Caller: library/ccm.c
2329 * library/cmac.c
2330 * library/gcm.c
2331 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002332 * library/pkcs12.c
2333 * library/pkcs5.c
2334 * library/psa_crypto_aead.c
2335 * library/psa_crypto_mac.c
2336 * library/ssl_ciphersuites.c
2337 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002338 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002339 *
2340 * Uncomment to enable generic cipher wrappers.
2341 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002343
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002344/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002345 * \def MBEDTLS_CMAC_C
2346 *
Simon Butcher327398a2016-10-05 14:09:11 +01002347 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2348 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002349 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002350 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2351 * implementation of the CMAC algorithm is provided by an alternate
2352 * implementation, that alternate implementation may opt to not support
2353 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2354 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002355 * Module: library/cmac.c
2356 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002357 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002358 *
2359 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002360#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002361
2362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002364 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002365 * Enable the CTR_DRBG AES-based random generator.
2366 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002367 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002368 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002369 * \note To achieve a 256-bit security strength with CTR_DRBG,
2370 * you must use AES-256 *and* use sufficient entropy.
2371 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002372 *
2373 * Module: library/ctr_drbg.c
2374 * Caller:
2375 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002377 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002378 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002379 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002380#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002381
2382/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002383 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002384 *
2385 * Enable the debug functions.
2386 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002388 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002389 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002390 * library/ssl_tls12_*.c
2391 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 *
2393 * This module provides debugging functions.
2394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002396
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002397/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002398 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002399 *
2400 * Enable the DES block cipher.
2401 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002403 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002404 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002405 *
Paul Bakkercff68422013-09-15 20:43:33 +02002406 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002407 *
2408 * \warning DES is considered a weak cipher and its use constitutes a
2409 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002412
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002415 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002416 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002417 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002418 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002419 * Caller: library/ssl_tls.c
2420 * library/ssl*_client.c
2421 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002422 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002423 * This module is used by the following key exchanges:
2424 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002425 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002426 * \warning Using DHE constitutes a security risk as it
2427 * is not possible to validate custom DH parameters.
2428 * If possible, it is recommended users should consider
2429 * preferring other methods of key exchange.
2430 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002431 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002434
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002435/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002437 *
2438 * Enable the elliptic curve Diffie-Hellman library.
2439 *
2440 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002441 * Caller: library/psa_crypto.c
2442 * library/ssl_tls.c
2443 * library/ssl*_client.c
2444 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002445 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002446 * This module is used by the following key exchanges:
2447 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002448 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002452
2453/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002454 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002455 *
2456 * Enable the elliptic curve DSA library.
2457 *
2458 * Module: library/ecdsa.c
2459 * Caller:
2460 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002461 * This module is used by the following key exchanges:
2462 * ECDHE-ECDSA
2463 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002464 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2465 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2466 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002469
2470/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002471 * \def MBEDTLS_ECJPAKE_C
2472 *
2473 * Enable the elliptic curve J-PAKE library.
2474 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002475 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2476 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002477 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002478 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002479 * Module: library/ecjpake.c
2480 * Caller:
2481 *
2482 * This module is used by the following key exchanges:
2483 * ECJPAKE
2484 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002485 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002486 *
2487 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2488 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002489 *
2490 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002491 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002492 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2493 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002494 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002495#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002496
2497/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002499 *
2500 * Enable the elliptic curve over GF(p) library.
2501 *
2502 * Module: library/ecp.c
2503 * Caller: library/ecdh.c
2504 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002505 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002506 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002510
2511/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002513 *
2514 * Enable the platform-specific entropy code.
2515 *
2516 * Module: library/entropy.c
2517 * Caller:
2518 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002520 *
2521 * This module provides a generic entropy pool
2522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002524
2525/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002527 *
2528 * Enable error code to error string conversion.
2529 *
2530 * Module: library/error.c
2531 * Caller:
2532 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002536
2537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002539 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002540 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002541 *
2542 * Module: library/gcm.c
2543 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002544 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2545 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002546 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002547 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2548 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002551
2552/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002553 * \def MBEDTLS_HKDF_C
2554 *
2555 * Enable the HKDF algorithm (RFC 5869).
2556 *
2557 * Module: library/hkdf.c
2558 * Caller:
2559 *
2560 * Requires: MBEDTLS_MD_C
2561 *
2562 * This module adds support for the Hashed Message Authentication Code
2563 * (HMAC)-based key derivation function (HKDF).
2564 */
2565#define MBEDTLS_HKDF_C
2566
2567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002569 *
2570 * Enable the HMAC_DRBG random generator.
2571 *
2572 * Module: library/hmac_drbg.c
2573 * Caller:
2574 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002575 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002576 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002577 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002579#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002580
2581/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002582 * \def MBEDTLS_LMS_C
2583 *
2584 * Enable the LMS stateful-hash asymmetric signature algorithm.
2585 *
2586 * Module: library/lms.c
2587 * Caller:
2588 *
Raef Colesab4f8742022-09-01 12:24:31 +01002589 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002590 *
Raef Colesab4f8742022-09-01 12:24:31 +01002591 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002592 */
2593#define MBEDTLS_LMS_C
2594
2595/**
Raef Colesab4f8742022-09-01 12:24:31 +01002596 * \def MBEDTLS_LMS_PRIVATE
2597 *
2598 * Enable LMS private-key operations and signing code. Functions enabled by this
2599 * option are experimental, and should not be used in production.
2600 *
2601 * Requires: MBEDTLS_LMS_C
2602 *
2603 * Uncomment to enable the LMS signature algorithm and private key operations.
2604 */
Raef Coles5127e852022-10-07 10:35:56 +01002605//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002606
2607/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002608 * \def MBEDTLS_NIST_KW_C
2609 *
2610 * Enable the Key Wrapping mode for 128-bit block ciphers,
2611 * as defined in NIST SP 800-38F. Only KW and KWP modes
2612 * are supported. At the moment, only AES is approved by NIST.
2613 *
2614 * Module: library/nist_kw.c
2615 *
2616 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2617 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002618#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002619
2620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622 *
2623 * Enable the generic message digest layer.
2624 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002625 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2626 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2627 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002628 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002629 * Caller: library/constant_time.c
2630 * library/ecdsa.c
2631 * library/ecjpake.c
2632 * library/hkdf.c
2633 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002634 * library/pk.c
2635 * library/pkcs5.c
2636 * library/pkcs12.c
2637 * library/psa_crypto_ecp.c
2638 * library/psa_crypto_rsa.c
2639 * library/rsa.c
2640 * library/ssl_cookie.c
2641 * library/ssl_msg.c
2642 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002643 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002644 * library/x509_crt.c
2645 * library/x509write_crt.c
2646 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002647 *
2648 * Uncomment to enable generic message digest wrappers.
2649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002650#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002651
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002652/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002653 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002654 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002655 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002656 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002657 * Module: library/md5.c
2658 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002659 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002660 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002661 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002662 * This module is required for TLS 1.2 depending on the handshake parameters.
2663 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2664 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002665 *
2666 * \warning MD5 is considered a weak message digest and its use constitutes a
2667 * security risk. If possible, we recommend avoiding dependencies on
2668 * it, and considering stronger message digests instead.
2669 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002671#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002672
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002673/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002675 *
2676 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002677 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002678 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002679 *
2680 * Module: library/memory_buffer_alloc.c
2681 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * Requires: MBEDTLS_PLATFORM_C
2683 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002684 *
2685 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002688
2689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002690 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002691 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002692 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2693 *
Simon Butcherd567a232016-03-09 20:19:21 +00002694 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2695 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002696 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002697 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002698 * \note See also our Knowledge Base article about porting to a new
2699 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002700 * 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 +00002701 *
Andres AG788aa4a2016-09-14 14:32:09 +01002702 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002703 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002704 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002705 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002706#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002707
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002708/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002710 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002711 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002712 *
2713 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002714 * Caller: library/asn1write.c
2715 * library/pkcs5.c
2716 * library/pkparse.c
2717 * library/pkwrite.c
2718 * library/rsa.c
2719 * library/x509.c
2720 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002721 * library/x509_crl.c
2722 * library/x509_crt.c
2723 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002724 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002725 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002726 *
2727 * This modules translates between OIDs and internal values.
2728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002729#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002730
2731/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002733 *
2734 * Enable VIA Padlock support on x86.
2735 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002736 * Module: library/padlock.c
2737 * Caller: library/aes.c
2738 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002740 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002741 * This modules adds support for the VIA PadLock on x86.
2742 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002744
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002746 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002747 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002748 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002749 *
2750 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002751 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002752 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002753 * library/x509_crl.c
2754 * library/x509_crt.c
2755 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002756 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002758 *
Paul Bakkercff68422013-09-15 20:43:33 +02002759 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002762
2763/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002764 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002765 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002766 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002767 *
2768 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002769 * Caller: library/pkwrite.c
2770 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002771 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002772 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002774 *
2775 * This modules adds support for encoding / writing PEM files.
2776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002778
2779/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002781 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002782 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002783 *
2784 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002785 * Caller: library/psa_crypto_rsa.c
2786 * library/ssl_tls.c
2787 * library/ssl*_client.c
2788 * library/ssl*_server.c
2789 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002790 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002791 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002792 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002793 * Uncomment to enable generic public key wrappers.
2794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002796
2797/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002799 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002800 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002801 *
2802 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002803 * Caller: library/x509_crt.c
2804 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002805 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002807 *
2808 * Uncomment to enable generic public key parse functions.
2809 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002810#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002811
2812/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002814 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002815 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002816 *
2817 * Module: library/pkwrite.c
2818 * Caller: library/x509write.c
2819 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002821 *
2822 * Uncomment to enable generic public key write functions.
2823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002824#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002825
2826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002827 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002828 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002829 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002830 *
2831 * Module: library/pkcs5.c
2832 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002833 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2834 *
2835 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2836 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002837 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002838 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002839 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002840 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2841 * this module in builds where MBEDTLS_MD_C is disabled.
2842 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002843 * This module adds support for the PKCS#5 functions.
2844 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002846
2847/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002848 * \def MBEDTLS_PKCS7_C
2849 *
Dave Rodgmandbcbf442022-12-05 11:15:10 +00002850 * This feature is a work in progress and not ready for production. Testing and
2851 * validation is incomplete, and handling of malformed inputs may not be robust.
2852 * The API may change.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002853 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002854 * Enable PKCS7 core for using PKCS7 formatted signatures.
2855 * RFC Link - https://tools.ietf.org/html/rfc2315
2856 *
2857 * Module: library/pkcs7.c
2858 *
2859 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002860 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2861 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002862 *
2863 * This module is required for the PKCS7 parsing modules.
2864 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002865//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002866
2867/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002869 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002870 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002871 * Adds algorithms for parsing PKCS#8 encrypted private keys
2872 *
2873 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002874 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002875 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002876 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2877 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2878 *
2879 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2880 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002881 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002882 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002883 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002884 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2885 * this module in builds where MBEDTLS_MD_C is disabled.
2886 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002887 * This module enables PKCS#12 functions.
2888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002890
2891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002892 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002893 *
2894 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002895 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2898 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002899 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002900 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002901 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002902 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002903 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002904 * Module: library/platform.c
2905 * Caller: Most other .c files
2906 *
2907 * This module enables abstraction of common (libc) functions.
2908 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002909#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002910
2911/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002912 * \def MBEDTLS_POLY1305_C
2913 *
2914 * Enable the Poly1305 MAC algorithm.
2915 *
2916 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002917 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002918 */
2919#define MBEDTLS_POLY1305_C
2920
2921/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002922 * \def MBEDTLS_PSA_CRYPTO_C
2923 *
2924 * Enable the Platform Security Architecture cryptography API.
2925 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002926 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002927 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002928 * Requires: MBEDTLS_CIPHER_C,
2929 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002930 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002931 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002932 *
2933 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002934#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002935
2936/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002937 * \def MBEDTLS_PSA_CRYPTO_SE_C
2938 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002939 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002940 * cryptography API.
2941 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002942 * \deprecated This feature is deprecated. Please switch to the driver
2943 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002944 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002945 * Module: library/psa_crypto_se.c
2946 *
2947 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2948 *
2949 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002950//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002951
2952/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002953 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2954 *
2955 * Enable the Platform Security Architecture persistent key storage.
2956 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002957 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002958 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002959 * Requires: MBEDTLS_PSA_CRYPTO_C,
2960 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2961 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002962 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002963#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002964
2965/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002966 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002967 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002968 * Enable the emulation of the Platform Security Architecture
2969 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002970 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002971 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002972 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002973 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002974 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002975#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002976
2977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002979 *
2980 * Enable the RIPEMD-160 hash algorithm.
2981 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002982 * Module: library/ripemd160.c
2983 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002984 *
2985 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002987
2988/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002990 *
2991 * Enable the RSA public-key cryptosystem.
2992 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002993 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002994 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002995 * Caller: library/pk.c
2996 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002998 * library/ssl*_client.c
2999 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003000 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003001 * This module is used by the following key exchanges:
3002 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003009 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003010 *
3011 * Enable the SHA1 cryptographic hash algorithm.
3012 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003013 * Module: library/sha1.c
3014 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003015 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003016 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003017 * This module is required for TLS 1.2 depending on the handshake parameters,
3018 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003019 *
3020 * \warning SHA-1 is considered a weak message digest and its use constitutes
3021 * a security risk. If possible, we recommend avoiding dependencies
3022 * on it, and considering stronger message digests instead.
3023 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003026
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003027/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003028 * \def MBEDTLS_SHA224_C
3029 *
3030 * Enable the SHA-224 cryptographic hash algorithm.
3031 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003032 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003033 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003034 *
3035 * Module: library/sha256.c
3036 * Caller: library/md.c
3037 * library/ssl_cookie.c
3038 *
3039 * This module adds support for SHA-224.
3040 */
3041#define MBEDTLS_SHA224_C
3042
3043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003045 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003046 * Enable the SHA-256 cryptographic hash algorithm.
3047 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003048 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003049 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003050 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003051 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003052 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003053 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003054 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003055 * library/ssl*_client.c
3056 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003057 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003058 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003059 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003062
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003063/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003064 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3065 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003066 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3067 * with the ARMv8 cryptographic extensions if they are available at runtime.
3068 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003069 *
3070 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3071 * for a non-Aarch64 build it will be silently ignored.
3072 *
3073 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3074 * of \c -march=armv8-a+crypto.
3075 *
3076 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3077 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3078 *
3079 * Requires: MBEDTLS_SHA256_C.
3080 *
3081 * Module: library/sha256.c
3082 *
3083 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3084 * and use them if available.
3085 */
3086//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3087
3088/**
3089 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3090 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003091 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3092 * with the ARMv8 cryptographic extensions, which must be available at runtime
3093 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003094 *
3095 * \note This allows builds with a smaller code size than with
3096 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3097 *
3098 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3099 * of \c -march=armv8-a+crypto.
3100 *
3101 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3102 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3103 *
3104 * Requires: MBEDTLS_SHA256_C.
3105 *
3106 * Module: library/sha256.c
3107 *
3108 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3109 * unconditionally.
3110 */
3111//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3112
3113/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003114 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003115 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003116 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003117 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003118 * Requires: MBEDTLS_SHA512_C
3119 *
3120 * Module: library/sha512.c
3121 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003122 * library/psa_crypto_hash.c
3123 * library/ssl_tls.c
3124 * library/ssl*_client.c
3125 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003126 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003127 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003128 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003129#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003130
3131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003132 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003134 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003135 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003136 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003137 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003138 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003139 * library/ssl_tls.c
3140 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003142 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003145
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003146/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003147 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3148 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003149 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3150 * with the ARMv8 cryptographic extensions if they are available at runtime.
3151 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003152 *
3153 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3154 * for a non-Aarch64 build it will be silently ignored.
3155 *
3156 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3157 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3158 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3159 * fastest code.
3160 *
3161 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3162 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3163 *
3164 * Requires: MBEDTLS_SHA512_C.
3165 *
3166 * Module: library/sha512.c
3167 *
3168 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3169 * and use them if available.
3170 */
3171//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3172
3173/**
3174 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3175 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003176 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3177 * with the ARMv8 cryptographic extensions, which must be available at runtime
3178 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003179 *
3180 * \note This allows builds with a smaller code size than with
3181 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3182 *
3183 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3184 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3185 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3186 * fastest code.
3187 *
3188 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3189 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3190 *
3191 * Requires: MBEDTLS_SHA512_C.
3192 *
3193 * Module: library/sha512.c
3194 *
3195 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3196 * unconditionally.
3197 */
3198//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3199
3200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003202 *
3203 * Enable simple SSL cache implementation.
3204 *
3205 * Module: library/ssl_cache.c
3206 * Caller:
3207 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003209 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003210#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003211
3212/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003214 *
3215 * Enable basic implementation of DTLS cookies for hello verification.
3216 *
3217 * Module: library/ssl_cookie.c
3218 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003221
3222/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003223 * \def MBEDTLS_SSL_TICKET_C
3224 *
3225 * Enable an implementation of TLS server-side callbacks for session tickets.
3226 *
3227 * Module: library/ssl_ticket.c
3228 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003229 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003230 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3231 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003232 */
3233#define MBEDTLS_SSL_TICKET_C
3234
3235/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003237 *
3238 * Enable the SSL/TLS client code.
3239 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003240 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003241 * Caller:
3242 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003244 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003245 * This module is required for SSL/TLS client support.
3246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003248
Paul Bakker9a736322012-11-14 12:39:52 +00003249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003251 *
3252 * Enable the SSL/TLS server code.
3253 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003254 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003255 * Caller:
3256 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003258 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003259 * This module is required for SSL/TLS server support.
3260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003261#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003262
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003263/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003265 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003266 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003268 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003269 * Caller: library/ssl*_client.c
3270 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003271 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003272 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3273 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003274 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003275 * This module is required for SSL/TLS.
3276 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003278
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003281 *
3282 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003283 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003284 * contexts are not shared between threads. If you do intend to use contexts
3285 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003286 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003287 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003288 *
3289 * Module: library/threading.c
3290 *
3291 * This allows different threading implementations (self-implemented or
3292 * provided).
3293 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294 * You will have to enable either MBEDTLS_THREADING_ALT or
3295 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003296 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003297 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003300
3301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003303 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003304 * Enable the semi-portable timing interface.
3305 *
Simon Butcherd567a232016-03-09 20:19:21 +00003306 * \note The provided implementation only works on POSIX/Unix (including Linux,
3307 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003308 * module and provide your own implementations of the callbacks needed by
3309 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3310 * your own implementation of the whole module by setting
3311 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003312 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003313 * \note The timing module will include time.h on suitable platforms
3314 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3315 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3316 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003317 * \note See also our Knowledge Base article about porting to a new
3318 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003319 * 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 +00003320 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003321 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003327 *
3328 * Enable run-time version information.
3329 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003330 * Module: library/version.c
3331 *
3332 * This module provides run-time version information.
3333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003335
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003336/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003337 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003338 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003339 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003340 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003341 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003342 * Caller: library/x509_crl.c
3343 * library/x509_crt.c
3344 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003345 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003346 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003347 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3348 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003349 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3350 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003351 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003352 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003354#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003355
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003356/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003358 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003359 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003360 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003361 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003362 * Caller: library/ssl_tls.c
3363 * library/ssl*_client.c
3364 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003365 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003367 *
3368 * This module is required for X.509 certificate parsing.
3369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371
3372/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003374 *
3375 * Enable X.509 CRL parsing.
3376 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003377 * Module: library/x509_crl.c
3378 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003379 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003381 *
3382 * This module is required for X.509 CRL parsing.
3383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003385
3386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
3389 * Enable X.509 Certificate Signing Request (CSR) parsing.
3390 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003391 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003392 * Caller: library/x509_crt_write.c
3393 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003395 *
3396 * This module is used for reading X.509 certificate request.
3397 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003398#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003399
3400/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003403 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003404 *
3405 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003406 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003407 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003408 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3409 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003410 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3411 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003412 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003413 * This module is the basis for creating X.509 certificates and CSRs.
3414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003416
3417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003418 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003419 *
3420 * Enable creating X.509 certificates.
3421 *
3422 * Module: library/x509_crt_write.c
3423 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003425 *
3426 * This module is required for X.509 certificate creation.
3427 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003429
3430/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003431 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003432 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003433 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003434 *
3435 * Module: library/x509_csr_write.c
3436 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003438 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003439 * This module is required for X.509 certificate request writing.
3440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003442
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003443/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003444
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003445/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003446 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003447 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003448 * This section contains Mbed TLS build settings that are not associated
3449 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003450 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003451 * \{
3452 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003453
Gilles Peskinea02c1242022-03-16 17:03:19 +01003454/**
3455 * \def MBEDTLS_CONFIG_FILE
3456 *
3457 * If defined, this is a header which will be included instead of
3458 * `"mbedtls/mbedtls_config.h"`.
3459 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003460 * Unlike other configuration options, this one must be defined on the
3461 * compiler command line: a definition in `mbedtls_config.h` would have
3462 * no effect.
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_CONFIG_FILE "mbedtls/mbedtls_config.h"
3472
3473/**
3474 * \def MBEDTLS_USER_CONFIG_FILE
3475 *
3476 * If defined, this is a header which will be included after
3477 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003478 * This allows you to modify the default configuration, including the ability
3479 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003480 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003481 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003482 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003483 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003484 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003485 * The value of this symbol is typically a path in double quotes, either
3486 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003487 */
3488//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3489
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003490/**
3491 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3492 *
3493 * If defined, this is a header which will be included instead of
3494 * `"psa/crypto_config.h"`.
3495 * This header file specifies which cryptographic mechanisms are available
3496 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3497 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3498 *
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_CONFIG_FILE "psa/crypto_config.h"
3507
3508/**
3509 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3510 *
3511 * If defined, this is a header which will be included after
3512 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003513 * This allows you to modify the default configuration, including the ability
3514 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003515 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003516 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003517 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003518 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003519 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003520 * The value of this symbol is typically a path in double quotes, either
3521 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003522 */
3523//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3524
Gilles Peskineba4162a2022-04-11 17:04:38 +02003525/** \} name SECTION: General configuration options */
3526
3527/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003528 * \name SECTION: Module configuration options
3529 *
3530 * This section allows for the setting of module specific sizes and
3531 * configuration options. The default values are already present in the
3532 * relevant header files and should suffice for the regular use cases.
3533 *
3534 * Our advice is to enable options and change their values here
3535 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003536 * \{
3537 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003538/* The Doxygen documentation here is used when a user comments out a
3539 * setting and runs doxygen themselves. On the other hand, when we typeset
3540 * the full documentation including disabled settings, the documentation
3541 * in specific modules' header files is used if present. When editing this
3542 * file, make sure that each option is documented in exactly one place,
3543 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3544 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003545
Paul Bakker088c5c52014-04-25 11:11:10 +02003546/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003547//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003549
Paul Bakker088c5c52014-04-25 11:11:10 +02003550/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3552//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3553//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3554//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3555//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003556
Paul Bakker088c5c52014-04-25 11:11:10 +02003557/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3559//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3560//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3561//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003562
Paul Bakker088c5c52014-04-25 11:11:10 +02003563/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003564//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003566
Paul Bakker088c5c52014-04-25 11:11:10 +02003567/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3569//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003570//#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 +01003571
Paul Bakker088c5c52014-04-25 11:11:10 +02003572/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003574
Paul Bakker088c5c52014-04-25 11:11:10 +02003575/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576//#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 +02003577//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003579//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003580//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003581//#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 +02003582//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3583//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003584/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003586//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3587//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003588//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3589//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3590//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003592/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3593/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003594//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3596//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003597//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003598//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3599//#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 +02003600//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3601//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003602/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003604//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003605//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3606//#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 +02003607
Gilles Peskine3f106f72021-09-23 17:42:39 +02003608/** \def MBEDTLS_CHECK_RETURN
3609 *
3610 * This macro is used at the beginning of the declaration of a function
3611 * to indicate that its return value should be checked. It should
3612 * instruct the compiler to emit a warning or an error if the function
3613 * is called without checking its return value.
3614 *
3615 * There is a default implementation for popular compilers in platform_util.h.
3616 * You can override the default implementation by defining your own here.
3617 *
3618 * If the implementation here is empty, this will effectively disable the
3619 * checking of functions' return values.
3620 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003621//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003622
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003623/** \def MBEDTLS_IGNORE_RETURN
3624 *
3625 * This macro requires one argument, which should be a C function call.
3626 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3627 * warning is suppressed.
3628 */
3629//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3630
Gilles Peskineed038902020-11-13 21:33:21 +01003631/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003632/**
Gilles Peskineed038902020-11-13 21:33:21 +01003633 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3634 * PSA crypto subsystem.
3635 *
3636 * If this option is unset:
3637 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003638 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003639 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3640 * on unspecified heuristics.
3641 */
3642//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3643
Steven Cooreman863470a2021-02-15 14:03:19 +01003644/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003645 * Restrict the PSA library to supporting a maximum amount of simultaneously
3646 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3647 * volatile key, or a persistent key which is loaded temporarily by the
3648 * library as part of a crypto operation in flight.
3649 *
3650 * If this option is unset, the library will fall back to a default value of
3651 * 32 keys.
3652 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003653//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003654
Paul Bakker088c5c52014-04-25 11:11:10 +02003655/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003656//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3657//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003658
Paul Bakker088c5c52014-04-25 11:11:10 +02003659/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003660
Angus Grattond8213d02016-05-25 20:56:48 +10003661/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3662 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003663 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003664 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003665 * This determines the size of the incoming TLS I/O buffer in such a way
3666 * that it is capable of holding the specified amount of plaintext data,
3667 * regardless of the protection mechanism used.
3668 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003669 * \note When using a value less than the default of 16KB on the client, it is
3670 * recommended to use the Maximum Fragment Length (MFL) extension to
3671 * inform the server about this limitation. On the server, there
3672 * is no supported, standardized way of informing the client about
3673 * restriction on the maximum size of incoming messages, and unless
3674 * the limitation has been communicated by other means, it is recommended
3675 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3676 * while keeping the default value of 16KB for the incoming buffer.
3677 *
David Horstmann95d516f2021-05-04 18:36:56 +01003678 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003679 */
3680//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3681
Gilles Peskined3d02902020-03-04 21:35:27 +01003682/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3683 *
3684 * The maximum length of CIDs used for incoming DTLS messages.
3685 *
3686 */
3687//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3688
3689/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3690 *
3691 * The maximum length of CIDs used for outgoing DTLS messages.
3692 *
3693 */
3694//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3695
TRodziewicze8dd7092021-05-12 14:19:11 +02003696/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003697 *
3698 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003699 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003700 *
3701 * The padding will always be chosen so that the length of the
3702 * padded plaintext is a multiple of the value of this option.
3703 *
3704 * Note: A value of \c 1 means that no padding will be used
3705 * for outgoing records.
3706 *
3707 * Note: On systems lacking division instructions,
3708 * a power of two should be preferred.
3709 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003710//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003711
Angus Grattond8213d02016-05-25 20:56:48 +10003712/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3713 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003714 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003715 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003716 * This determines the size of the outgoing TLS I/O buffer in such a way
3717 * that it is capable of holding the specified amount of plaintext data,
3718 * regardless of the protection mechanism used.
3719 *
Angus Grattond8213d02016-05-25 20:56:48 +10003720 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3721 * the default inward 16384 byte buffer to conform to the TLS specification.
3722 *
3723 * The minimum required outward buffer size is determined by the handshake
3724 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3725 * The specific size requirement depends on the configured ciphers and any
3726 * certificate data which is sent during the handshake.
3727 *
David Horstmann95d516f2021-05-04 18:36:56 +01003728 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003729 */
3730//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3731
Hanno Beckere0b150f2018-08-21 15:51:03 +01003732/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3733 *
3734 * Maximum number of heap-allocated bytes for the purpose of
3735 * DTLS handshake message reassembly and future message buffering.
3736 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003737 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003738 * to account for a reassembled handshake message of maximum size,
3739 * together with its reassembly bitmap.
3740 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003741 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003742 * should be sufficient for all practical situations as it allows
3743 * to reassembly a large handshake message (such as a certificate)
3744 * while buffering multiple smaller handshake messages.
3745 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003746 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003747//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003748
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3750//#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 +02003751
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003752/**
3753 * Complete list of ciphersuites to use, in order of preference.
3754 *
3755 * \warning No dependency checking is done on that field! This option can only
3756 * be used to restrict the set of available ciphersuites. It is your
3757 * responsibility to make sure the needed modules are active.
3758 *
3759 * Use this to save a few hundred bytes of ROM (default ordering of all
3760 * available ciphersuites) and a few to a few hundred bytes of RAM.
3761 *
3762 * The value below is only an example, not the default.
3763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764//#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 +02003765
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003766/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003767//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003768//#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 +01003769
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003770/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003771 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003772 * mbedtls_platform_zeroize(). This replaces the default implementation in
3773 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003774 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003775 * mbedtls_platform_zeroize() is a widely used function across the library to
3776 * zero a block of memory. The implementation is expected to be secure in the
3777 * sense that it has been written to prevent the compiler from removing calls
3778 * to mbedtls_platform_zeroize() as part of redundant code elimination
3779 * optimizations. However, it is difficult to guarantee that calls to
3780 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3781 * versions of the C language standards do not provide a secure implementation
3782 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3783 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003784 * example by using directives specific to their compiler, features from newer
3785 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003786 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003787 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003788//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003789
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003790/**
3791 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003792 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003793 * platform_util.c.
3794 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003795 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003796 * library will try to use safer implementations of this function, such as
3797 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003798 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003799 * using the standard gmtime(). In this case, calls from the library to
3800 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003801 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003802 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003803 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3804 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3805 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003806 */
Hanno Becker6a739782018-09-05 15:06:19 +01003807//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003808
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003809/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003810 * Enable the verified implementations of ECDH primitives from Project Everest
3811 * (currently only Curve25519). This feature changes the layout of ECDH
3812 * contexts and therefore is a compatibility break for applications that access
3813 * fields of a mbedtls_ecdh_context structure directly. See also
3814 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003815 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003816//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003817
Gilles Peskine611179c2022-04-13 23:04:48 +02003818/** \} name SECTION: Module configuration options */