blob: b5f0bf2b4e8233140130d6c3be8508e78a2417de [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:
704 * - ECDH operations from the key exchange;
705 * - verification of the server's key exchange signature;
706 * - verification of the server's certificate chain;
707 * - generation of our signature if client authentication is used, with an
708 * ECC key/certificate.
709 *
710 * \note In the cases above, the usual SSL/TLS functions, such as
711 * mbedtls_ssl_handshake(), can now return
712 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200713 *
Ron Eldor19779c42018-11-05 16:58:13 +0200714 * \note This option only works with the default software implementation of
715 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100716 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
717 * and MBEDTLS_USE_PSA_CRYPTO.
718 *
719 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100720 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200721//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100722
723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200724 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100725 *
726 * Enable deterministic ECDSA (RFC 6979).
727 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
728 * may result in a compromise of the long-term signing key. This is avoided by
729 * the deterministic variant.
730 *
John Durkop36a82e52020-10-26 09:39:05 -0700731 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100732 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100733 * Comment this macro to disable deterministic ECDSA.
734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100736
737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200738 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200739 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200740 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200741 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200742 * This enables the following ciphersuites (if other requisites are
743 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
745 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
746 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
747 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
748 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
749 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
750 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
751 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
752 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
753 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200754 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200755#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200756
757/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200759 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200760 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
764 * This enables the following ciphersuites (if other requisites are
765 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200766 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
767 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
768 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
769 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
770 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
771 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
772 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
774 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
775 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100776 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100777 * \warning Using DHE constitutes a security risk as it
778 * is not possible to validate custom DH parameters.
779 * If possible, it is recommended users should consider
780 * preferring other methods of key exchange.
781 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100782 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785
786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200788 *
789 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
790 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200792 *
793 * This enables the following ciphersuites (if other requisites are
794 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200795 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
796 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
797 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
798 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803
804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200806 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200807 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200808 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
810 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200811 *
812 * This enables the following ciphersuites (if other requisites are
813 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
815 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
816 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
817 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
818 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
819 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
820 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
822 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
823 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826
827/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200830 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
833 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
835 * This enables the following ciphersuites (if other requisites are
836 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
838 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
839 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
840 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
841 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
842 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
843 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
844 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
845 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
846 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200849 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851
852/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200855 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
858 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
860 * This enables the following ciphersuites (if other requisites are
861 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
863 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
864 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
865 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
866 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
867 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
868 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
871 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100874 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100875 * \warning Using DHE constitutes a security risk as it
876 * is not possible to validate custom DH parameters.
877 * If possible, it is recommended users should consider
878 * preferring other methods of key exchange.
879 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100880 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883
884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200887 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
890 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200891 *
892 * This enables the following ciphersuites (if other requisites are
893 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
895 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
896 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
897 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
898 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200909 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200910 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200911 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
917 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
918 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
919 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
920 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
921 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
922 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200928
929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100931 *
932 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
933 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200934 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935 *
936 * This enables the following ciphersuites (if other requisites are
937 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
939 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
940 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
942 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
943 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
944 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950
951/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200952 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100953 *
954 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
955 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200956 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100957 *
958 * This enables the following ciphersuites (if other requisites are
959 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200960 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
961 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
962 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
963 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
964 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
965 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
966 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
967 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
968 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
969 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100972
973/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200974 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
975 *
976 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
977 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200978 * \warning This is currently experimental. EC J-PAKE support is based on the
979 * Thread v1.0.0 specification; incompatible changes to the specification
980 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200981 *
982 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200983 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200984 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
985 *
986 * This enables the following ciphersuites (if other requisites are
987 * enabled as well):
988 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
989 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200990//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200991
992/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200993 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100994 *
995 * Enhance support for reading EC keys using variants of SEC1 not allowed by
996 * RFC 5915 and RFC 5480.
997 *
998 * Currently this means parsing the SpecifiedECDomain choice of EC
999 * parameters (only known groups are supported, not arbitrary domains, to
1000 * avoid validation issues).
1001 *
1002 * Disable if you only need to support RFC 5915 + 5480 key formats.
1003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001005
1006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001007 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001008 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * Enable a dummy error function to make use of mbedtls_strerror() in
1010 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1011 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001012 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1014 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001015 *
1016 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001017 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001020
1021/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001023 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001024 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001025 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001029
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001032 *
1033 * Enable functions that use the filesystem.
1034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001036
1037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001039 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001040 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001041 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001042 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001043 * application.
1044 *
1045 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001047//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001048
1049/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001050 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001051 *
1052 * Do not use built-in platform entropy functions.
1053 * This is useful if your platform does not support
1054 * standards like the /dev/urandom or Windows CryptoAPI.
1055 *
1056 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001059
1060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001061 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001062 *
1063 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1064 * default SHA-512 based one (if both are available).
1065 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001067 *
1068 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1069 * if you have performance concerns.
1070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 * This option is only useful if both MBEDTLS_SHA256_C and
1072 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001075
1076/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001077 * \def MBEDTLS_ENTROPY_NV_SEED
1078 *
1079 * Enable the non-volatile (NV) seed file-based entropy source.
1080 * (Also enables the NV seed read/write functions in the platform layer)
1081 *
1082 * This is crucial (if not required) on systems that do not have a
1083 * cryptographic entropy source (in hardware or kernel) available.
1084 *
1085 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1086 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001087 * \note The read/write functions that are used by the entropy source are
1088 * determined in the platform layer, and can be modified at runtime and/or
1089 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1090 *
1091 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001092 * with regular fopen(), please make sure you make a seedfile with the
1093 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1094 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001095 * and written to or you will get an entropy source error! The default
1096 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1097 * bytes from the file.
1098 *
1099 * \note The entropy collector will write to the seed file before entropy is
1100 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001101 */
1102//#define MBEDTLS_ENTROPY_NV_SEED
1103
Ronald Cron71016a92020-08-28 19:01:50 +02001104/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001105 *
Ronald Cron71016a92020-08-28 19:01:50 +02001106 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001107 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001108 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1109 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001110 *
1111 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001112 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001113 */
Ronald Cron71016a92020-08-28 19:01:50 +02001114//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001115
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001118 *
1119 * Enable debugging of buffer allocator memory issues. Automatically prints
1120 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1121 * function for 'debug output' of allocated memory.
1122 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001123 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001124 *
1125 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001128
1129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001131 *
1132 * Include backtrace information with each allocated block.
1133 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001135 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001136 *
1137 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001139//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001140
1141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001142 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001143 *
1144 * Support external private RSA keys (eg from a HSM) in the PK layer.
1145 *
1146 * Comment this macro to disable support for external private RSA keys.
1147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001148#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001149
1150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001152 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001153 * Enable support for PKCS#1 v1.5 encoding.
1154 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001155 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001156 *
Paul Bakker48377d92013-08-30 12:06:24 +02001157 * This enables support for PKCS#1 v1.5 operations.
1158 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001159#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001160
1161/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001163 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001164 * Enable support for PKCS#1 v2.1 encoding.
1165 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001166 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1167 *
1168 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1169 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001170 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001171 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001172 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001173 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1174 * this module in builds where MBEDTLS_MD_C is disabled.
1175 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001176 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001179
Steven Cooreman6801f082021-02-19 17:21:22 +01001180/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1181 *
1182 * Enable support for platform built-in keys. If you enable this feature,
1183 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1184 * See the documentation of that function for more information.
1185 *
1186 * Built-in keys are typically derived from a hardware unique key or
1187 * stored in a secure element.
1188 *
1189 * Requires: MBEDTLS_PSA_CRYPTO_C.
1190 *
1191 * \warning This interface is experimental and may change or be removed
1192 * without notice.
1193 */
1194//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1195
Ronald Cron3768ac12021-01-26 16:58:00 +01001196/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1197 *
1198 * Enable support for PSA crypto client.
1199 *
1200 * \note This option allows to include the code necessary for a PSA
1201 * crypto client when the PSA crypto implementation is not included in
1202 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1203 * code to set and get PSA key attributes.
1204 * The development of PSA drivers partially relying on the library to
1205 * fulfill the hardware gaps is another possible usage of this option.
1206 *
1207 * \warning This interface is experimental and may change or be removed
1208 * without notice.
1209 */
1210//#define MBEDTLS_PSA_CRYPTO_CLIENT
1211
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001212/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1213 *
1214 * Enable support for the experimental PSA crypto driver interface.
1215 *
John Durkop185764f2020-10-12 21:32:12 -07001216 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001217 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001218 * \warning This interface is experimental. We intend to maintain backward
1219 * compatibility with application code that relies on drivers,
1220 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001221 */
1222//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1223
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001224/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1225 *
1226 * Make the PSA Crypto module use an external random generator provided
1227 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1228 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001229 * \note This random generator must deliver random numbers with cryptographic
1230 * quality and high performance. It must supply unpredictable numbers
1231 * with a uniform distribution. The implementation of this function
1232 * is responsible for ensuring that the random generator is seeded
1233 * with sufficient entropy. If you have a hardware TRNG which is slow
1234 * or delivers non-uniform output, declare it as an entropy source
1235 * with mbedtls_entropy_add_source() instead of enabling this option.
1236 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001237 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001238 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1239 * and define a function called mbedtls_psa_external_get_random()
1240 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001241 * ```
1242 * psa_status_t mbedtls_psa_external_get_random(
1243 * mbedtls_psa_external_random_context_t *context,
1244 * uint8_t *output, size_t output_size, size_t *output_length);
1245 * );
1246 * ```
1247 * The \c context value is initialized to 0 before the first call.
1248 * The function must fill the \c output buffer with \p output_size bytes
1249 * of random data and set \c *output_length to \p output_size.
1250 *
1251 * Requires: MBEDTLS_PSA_CRYPTO_C
1252 *
1253 * \warning If you enable this option, code that uses the PSA cryptography
1254 * interface will not use any of the entropy sources set up for
1255 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1256 * enables.
1257 *
1258 * \note This option is experimental and may be removed without notice.
1259 */
1260//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1261
Paul Bakker9dcc3222011-03-08 14:16:06 +00001262/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001263 * \def MBEDTLS_PSA_CRYPTO_SPM
1264 *
1265 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1266 * Partition Manager) integration which separates the code into two parts: a
1267 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1268 * Environment).
1269 *
1270 * Module: library/psa_crypto.c
1271 * Requires: MBEDTLS_PSA_CRYPTO_C
1272 *
1273 */
1274//#define MBEDTLS_PSA_CRYPTO_SPM
1275
1276/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001277 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001278 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001279 * Enable support for entropy injection at first boot. This feature is
1280 * required on systems that do not have a built-in entropy source (TRNG).
1281 * This feature is currently not supported on systems that have a built-in
1282 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001283 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001284 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 *
1286 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001287//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001288
1289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001291 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001292 * Do not use the Chinese Remainder Theorem
1293 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001294 *
1295 * Uncomment this macro to disable the use of CRT in RSA.
1296 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001299
1300/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001302 *
1303 * Enable the checkup functions (*_self_test).
1304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001306
1307/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001308 * \def MBEDTLS_SHA256_SMALLER
1309 *
1310 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1311 * lower performance.
1312 *
Adam Wolf039080f2019-09-10 09:53:08 -05001313 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001314 * performance and size. This version optimizes more aggressively for size at
1315 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1316 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1317 * 30%.
1318 *
1319 * Uncomment to enable the smaller implementation of SHA256.
1320 */
1321//#define MBEDTLS_SHA256_SMALLER
1322
1323/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001324 * \def MBEDTLS_SHA512_SMALLER
1325 *
1326 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1327 * lower performance.
1328 *
1329 * Uncomment to enable the smaller implementation of SHA512.
1330 */
1331//#define MBEDTLS_SHA512_SMALLER
1332
1333/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001335 *
1336 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001337 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001338 * with other servers, only debugging of failures is harder.
1339 *
1340 * The advantage of not sending alert messages, is that no information is given
1341 * about reasons for failures thus preventing adversaries of gaining intel.
1342 *
1343 * Enable sending of all alert messages
1344 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001345#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001346
1347/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001348 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1349 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001350 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001351 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001352 * in the underlying transport. The CID functionality is described
1353 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001354 *
1355 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001356 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1357 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1358 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001359 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001360 * The maximum lengths of outgoing and incoming CIDs can be configured
1361 * through the options
1362 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1363 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1364 *
1365 * Requires: MBEDTLS_SSL_PROTO_DTLS
1366 *
1367 * Uncomment to enable the Connection ID extension.
1368 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001369#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1370
1371
1372/**
1373 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1374 *
1375 * Defines whether RFC 9146 (default) or the legacy version
1376 * (version draft-ietf-tls-dtls-connection-id-05,
1377 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1378 * is used.
1379 *
1380 * Set the value to 0 for the standard version, and
1381 * 1 for the legacy draft version.
1382 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001383 * \deprecated Support for the legacy version of the DTLS
1384 * Connection ID feature is deprecated. Please
1385 * switch to the standardized version defined
1386 * in RFC 9146 enabled by utilizing
1387 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1388 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1389 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001390 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1391 */
1392#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001393
1394/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001395 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1396 *
1397 * Enable asynchronous external private key operations in SSL. This allows
1398 * you to configure an SSL connection to call an external cryptographic
1399 * module to perform private key operations instead of performing the
1400 * operation inside the library.
1401 *
1402 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001403//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001404
1405/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001406 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1407 *
1408 * Enable serialization of the TLS context structures, through use of the
1409 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1410 *
1411 * This pair of functions allows one side of a connection to serialize the
1412 * context associated with the connection, then free or re-use that context
1413 * while the serialized state is persisted elsewhere, and finally deserialize
1414 * that state to a live context for resuming read/write operations on the
1415 * connection. From a protocol perspective, the state of the connection is
1416 * unaffected, in particular this is entirely transparent to the peer.
1417 *
1418 * Note: this is distinct from TLS session resumption, which is part of the
1419 * protocol and fully visible by the peer. TLS session resumption enables
1420 * establishing new connections associated to a saved session with shorter,
1421 * lighter handshakes, while context serialization is a local optimization in
1422 * handling a single, potentially long-lived connection.
1423 *
1424 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1425 * saved after the handshake to allow for more efficient serialization, so if
1426 * you don't need this feature you'll save RAM by disabling it.
1427 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001428 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1429 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001430 * Comment to disable the context serialization APIs.
1431 */
1432#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1433
1434/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001436 *
1437 * Enable the debug messages in SSL module for all issues.
1438 * Debug messages have been disabled in some places to prevent timing
1439 * attacks due to (unbalanced) debugging function calls.
1440 *
1441 * If you need all error reporting you should enable this during debugging,
1442 * but remove this for production servers that should log as well.
1443 *
1444 * Uncomment this macro to report all debug messages on errors introducing
1445 * a timing side-channel.
1446 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001447 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001448//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001449
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001451 *
1452 * Enable support for Encrypt-then-MAC, RFC 7366.
1453 *
1454 * This allows peers that both support it to use a more robust protection for
1455 * ciphersuites using CBC, providing deep resistance against timing attacks
1456 * on the padding or underlying cipher.
1457 *
1458 * This only affects CBC ciphersuites, and is useless if none is defined.
1459 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001460 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001461 *
1462 * Comment this macro to disable support for Encrypt-then-MAC
1463 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001464#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001467 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001468 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1469 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001470 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001471 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001472 * attacks, but it is recommended to always use it (even if you disable
1473 * renegotiation), since it actually fixes a more fundamental issue in the
1474 * original SSL/TLS design, and has implications beyond Triple Handshake.
1475 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001476 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001477 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001478 * Comment this macro to disable support for Extended Master Secret.
1479 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001481
Paul Bakkerd66f0702013-01-31 16:57:45 +01001482/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001483 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1484 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001485 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001486 * giving access to the peer's certificate after completion of the handshake.
1487 *
1488 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1489 * recommended to disable this option for reduced RAM usage.
1490 *
1491 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1492 * defined, but always returns \c NULL.
1493 *
1494 * \note This option has no influence on the protection against the
1495 * triple handshake attack. Even if it is disabled, Mbed TLS will
1496 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001497 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001498 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001499 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1500 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001501 * Comment this macro to disable storing the peer's certificate
1502 * after the handshake.
1503 */
1504#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1505
1506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001508 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001509 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001510 *
1511 * The two main uses of renegotiation are (1) refresh keys on long-lived
1512 * connections and (2) client authentication after the initial handshake.
1513 * If you don't need renegotiation, it's probably better to disable it, since
1514 * it has been associated with security issues in the past and is easy to
1515 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001516 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001517 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001518 *
1519 * \note Even if this option is disabled, both client and server are aware
1520 * of the Renegotiation Indication Extension (RFC 5746) used to
1521 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1522 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1523 * configuration of this extension).
1524 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001527
1528/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001529 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001530 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001531 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001532 *
1533 * Comment this macro to disable support for the max_fragment_length extension
1534 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001535#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001536
1537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001539 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001540 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001541 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001542 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1543 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1544 * With MBEDTLS_USE_PSA_CRYPTO:
1545 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1546 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001547 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001548 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1549 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001550 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001551 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001554
1555/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001556 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001557 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001558 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001559 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001560 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1561 * pre-shared keys are not supported.
1562 * See docs/architecture/tls13-support.md for a description of the TLS
1563 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001564 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001565 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001566 * Requires: MBEDTLS_PSA_CRYPTO_C
1567 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001568 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1569 * for most operations, if you want it to only use PSA for all crypto
1570 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1571 * operations, and functions that are common with TLS 1.2 (record protection,
1572 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001573 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001574 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001575 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001576//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001577
1578/**
Ronald Cronab65c522021-11-24 10:47:20 +01001579 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1580 *
1581 * Enable TLS 1.3 middlebox compatibility mode.
1582 *
1583 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1584 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1585 * expecting TLS 1.2 traffic.
1586 *
1587 * Turning on the compatibility mode comes at the cost of a few added bytes
1588 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1589 * that don't use it. Therefore, unless transmission bandwidth is critical and
1590 * you know that middlebox compatibility issues won't occur, it is therefore
1591 * recommended to set this option.
1592 *
1593 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001594 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1595 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001596 *
1597 */
1598//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1599
1600/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001601 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1602 *
1603 * Enable TLS 1.3 PSK key exchange mode.
1604 *
1605 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1606 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1607 * effect on the build.
1608 *
1609 */
1610#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1611
1612/**
1613 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1614 *
1615 * Enable TLS 1.3 ephemeral key exchange mode.
1616 *
1617 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1618 * MBEDTLS_PKCS1_V21
1619 *
1620 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1621 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1622 * effect on the build.
1623 *
1624 */
1625#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1626
1627/**
1628 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1629 *
1630 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1631 *
1632 * Requires: MBEDTLS_ECDH_C
1633 *
1634 * Comment to disable support for the PSK ephemeral key exchange mode in
1635 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1636 * have any effect on the build.
1637 *
1638 */
1639#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1640
1641/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001642 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001643 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001644 * Maximum time difference in milliseconds tolerated between the age of a
1645 * ticket from the server and client point of view.
1646 * From the client point of view, the age of a ticket is the time difference
1647 * between the time when the client proposes to the server to use the ticket
1648 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1649 * the time the client received the ticket from the server.
1650 * From the server point of view, the age of a ticket is the time difference
1651 * between the time when the server receives a proposition from the client
1652 * to use the ticket and the time when the ticket was created by the server.
1653 * The server age is expected to be always greater than the client one and
1654 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1655 * maximum difference tolerated for the server to accept the ticket.
1656 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001657 *
1658 */
1659#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1660
1661/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001662 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1663 *
1664 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1665 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001666 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001667 */
Jerry Yu9750f812022-07-20 11:04:50 +08001668#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001669
1670/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001671 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1672 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001673 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1674 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1675 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001676 *
1677 */
1678#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1679
1680/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001681* \def MBEDTLS_SSL_EARLY_DATA
1682*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001683* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001684*
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001685* Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1686* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1687* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001688*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001689* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001690* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001691*
1692* This feature is experimental, not completed and thus not ready for
1693* production.
1694*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001695*/
Ronald Cronc2e110f2022-11-22 09:01:46 +01001696//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001697
1698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001700 *
1701 * Enable support for DTLS (all available versions).
1702 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001703 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001705 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001706 *
1707 * Comment this macro to disable support for DTLS
1708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001709#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001710
1711/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001713 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001714 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001715 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001716 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001717 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001719
1720/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001722 *
1723 * Enable support for the anti-replay mechanism in DTLS.
1724 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725 * Requires: MBEDTLS_SSL_TLS_C
1726 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001727 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001728 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001729 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001730 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001731 * Comment this to disable anti-replay in DTLS.
1732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734
1735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001737 *
1738 * Enable support for HelloVerifyRequest on DTLS servers.
1739 *
1740 * This feature is highly recommended to prevent DTLS servers being used as
1741 * amplifiers in DoS attacks against other hosts. It should always be enabled
1742 * unless you know for sure amplification cannot be a problem in the
1743 * environment in which your server operates.
1744 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001745 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001746 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001747 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001748 *
1749 * Comment this to disable support for HelloVerifyRequest.
1750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001751#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001752
1753/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001754 * \def MBEDTLS_SSL_DTLS_SRTP
1755 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001756 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001757 * through the use_srtp extension.
1758 *
1759 * \note This feature provides the minimum functionality required
1760 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1761 * the associated SRTP packet protection key material.
1762 * In particular, the SRTP packet protection itself, as well as the
1763 * demultiplexing of RTP and DTLS packets at the datagram layer
1764 * (see Section 5 of RFC 5764), are not handled by this feature.
1765 * Instead, after successful completion of a handshake negotiating
1766 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001767 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001768 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1769 * (this is implemented in the SSL example programs).
1770 * The resulting key should then be passed to an SRTP stack.
1771 *
1772 * Setting this option enables the runtime API
1773 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1774 * through which the supported DTLS-SRTP protection
1775 * profiles can be configured. You must call this API at
1776 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001777 *
1778 * Requires: MBEDTLS_SSL_PROTO_DTLS
1779 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001780 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001781 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001782//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001783
1784/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001785 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1786 *
1787 * Enable server-side support for clients that reconnect from the same port.
1788 *
1789 * Some clients unexpectedly close the connection and try to reconnect using the
1790 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001791 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001792 * flag enables that support.
1793 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001794 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001795 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001796 * Comment this to disable support for clients reusing the source port.
1797 */
1798#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1799
1800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001802 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001803 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001804 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001805 * session store remains the responsibility of the application, though).
1806 * Server-side, you also need to provide callbacks for writing and parsing
1807 * tickets, including authenticated encryption and key management. Example
1808 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001809 *
1810 * Comment this macro to disable support for SSL session tickets
1811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001813
1814/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001815 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001816 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001817 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001818 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001820 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001821 * Comment this macro to disable support for server name indication in SSL
1822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001823#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001824
1825/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001826 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1827 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001828 * When this option is enabled, the SSL buffer will be resized automatically
1829 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001830 *
1831 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001832 */
1833//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1834
1835/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001836 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1837 *
1838 * Enable testing of the constant-flow nature of some sensitive functions with
1839 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001840 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001841 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001842 * This setting requires compiling with clang -fsanitize=memory. The test
1843 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001844 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001845 * \warning This macro is only used for extended testing; it is not considered
1846 * part of the library's API, so it may change or disappear at any time.
1847 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001848 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001849 */
1850//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1851
1852/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001853 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1854 *
1855 * Enable testing of the constant-flow nature of some sensitive functions with
1856 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001857 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001858 *
1859 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001860 * testing if the tests suites are run with valgrind's memcheck. This can be
1861 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1862 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001863 *
1864 * \warning This macro is only used for extended testing; it is not considered
1865 * part of the library's API, so it may change or disappear at any time.
1866 *
1867 * Uncomment to enable testing of the constant-flow nature of selected code.
1868 */
1869//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1870
1871/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001872 * \def MBEDTLS_TEST_HOOKS
1873 *
1874 * Enable features for invasive testing such as introspection functions and
1875 * hooks for fault injection. This enables additional unit tests.
1876 *
1877 * Merely enabling this feature should not change the behavior of the product.
1878 * It only adds new code, and new branching points where the default behavior
1879 * is the same as when this feature is disabled.
1880 * However, this feature increases the attack surface: there is an added
1881 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1882 * Therefore this feature must never be enabled in production.
1883 *
1884 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1885 * information.
1886 *
1887 * Uncomment to enable invasive tests.
1888 */
1889//#define MBEDTLS_TEST_HOOKS
1890
1891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001892 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001893 *
1894 * Provide your own alternate threading implementation.
1895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001897 *
1898 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001899 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001900//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001901
1902/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001904 *
1905 * Enable the pthread wrapper layer for the threading layer.
1906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001908 *
1909 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001912
1913/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001914 * \def MBEDTLS_USE_PSA_CRYPTO
1915 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001916 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1917 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001918 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001919 * \note Development of this option is currently in progress, and parts of Mbed
1920 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001921 * will still continue to work as usual, so enabling this option should not
1922 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001923 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001924 * \note See docs/use-psa-crypto.md for a complete description of what this
1925 * option currently does, and of parts that are not affected by it so far.
1926 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001927 * \warning If you enable this option, you need to call `psa_crypto_init()`
1928 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001929 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001930 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001931 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001932 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001933 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001934 */
1935//#define MBEDTLS_USE_PSA_CRYPTO
1936
1937/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001938 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1939 *
John Durkop185764f2020-10-12 21:32:12 -07001940 * This setting allows support for cryptographic mechanisms through the PSA
1941 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001942 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001943 * When this option is disabled, the PSA API exposes the cryptographic
1944 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1945 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001946 *
1947 * When this option is enabled, the PSA API exposes the cryptographic
1948 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1949 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1950 * automatically enabled if required (i.e. if no PSA driver provides the
1951 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1952 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001953 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001954 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001955 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001956 *
John Durkop185764f2020-10-12 21:32:12 -07001957 * This feature is still experimental and is not ready for production since
1958 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001959 */
1960//#define MBEDTLS_PSA_CRYPTO_CONFIG
1961
1962/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001963 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001964 *
1965 * Allow run-time checking of compile-time enabled features. Thus allowing users
1966 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001970 *
1971 * Comment this to disable run-time checking and save ROM space
1972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001974
1975/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001976 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1977 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001978 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001979 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1980 * the set of trusted certificates through a callback instead of a linked
1981 * list.
1982 *
1983 * This is useful for example in environments where a large number of trusted
1984 * certificates is present and storing them in a linked list isn't efficient
1985 * enough, or when the set of trusted certificates changes frequently.
1986 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001987 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001988 * `mbedtls_ssl_conf_ca_cb()` for more information.
1989 *
1990 * Uncomment to enable trusted certificate callbacks.
1991 */
1992//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1993
1994/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001995 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001996 *
Chris Jones2c745862020-12-16 11:41:06 +00001997 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001998 *
Chris Jones2c745862020-12-16 11:41:06 +00001999 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002000 * and other functions/constants only used by these functions, thus reducing
2001 * the code footprint by several KB.
2002 */
Chris Jones2c745862020-12-16 11:41:06 +00002003//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002004
2005/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002007 *
2008 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2009 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2010 *
2011 * Comment this macro to disallow using RSASSA-PSS in certificates.
2012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002014/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002015
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002016/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002017 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002018 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002019 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002020 * \{
2021 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002022
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002023/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002024 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002025 *
2026 * Enable AES-NI support on x86-64.
2027 *
2028 * Module: library/aesni.c
2029 * Caller: library/aes.c
2030 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002032 *
2033 * This modules adds support for the AES-NI instructions on x86-64
2034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002036
2037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002038 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002039 *
2040 * Enable the AES block cipher.
2041 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002042 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002043 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002044 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002045 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002046 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002047 * This module enables the following ciphersuites (if other requisites are
2048 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2050 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2051 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2052 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2053 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2054 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2055 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2056 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2057 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2058 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2059 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2060 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2061 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2062 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2063 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2064 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2065 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2066 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2067 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2068 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2069 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2070 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2071 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2072 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2074 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2075 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2076 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2077 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2078 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2079 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2080 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2081 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2082 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2083 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2084 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2085 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2086 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2087 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2088 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2089 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2090 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2091 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2092 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2093 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2094 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2095 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2096 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2097 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2098 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2099 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2100 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2101 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2102 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2103 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2104 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2105 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2106 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002107 *
Paul Bakkercff68422013-09-15 20:43:33 +02002108 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002111
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002114 *
2115 * Enable the generic ASN1 parser.
2116 *
2117 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002118 * Caller: library/x509.c
2119 * library/dhm.c
2120 * library/pkcs12.c
2121 * library/pkcs5.c
2122 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002123 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002124#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002125
2126/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002127 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002128 *
2129 * Enable the generic ASN1 writer.
2130 *
2131 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002132 * Caller: library/ecdsa.c
2133 * library/pkwrite.c
2134 * library/x509_create.c
2135 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002136 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002137 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002138#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002139
2140/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002141 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002142 *
2143 * Enable the Base64 module.
2144 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002145 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002146 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002148 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002150#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002151
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002154 *
Paul Bakker9a736322012-11-14 12:39:52 +00002155 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002156 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002157 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002158 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002159 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002160 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002161 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002162 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002163 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002164 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002165 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002166 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002167 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002168 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002171
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002172/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002173 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002174 *
2175 * Enable the Camellia block cipher.
2176 *
Paul Bakker38119b12009-01-10 23:31:23 +00002177 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002178 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002179 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002180 * This module enables the following ciphersuites (if other requisites are
2181 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2184 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2186 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2188 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2189 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2190 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2192 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2193 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2194 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2195 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2196 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2197 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2198 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2199 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2200 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2201 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2202 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2203 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2204 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2205 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2206 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2207 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2208 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2209 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2210 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2211 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2212 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2213 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2214 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2215 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2216 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2217 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2218 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2219 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2220 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2221 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2222 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2223 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002225#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002226
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002227/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002228 * \def MBEDTLS_ARIA_C
2229 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002230 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002231 *
2232 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002233 * Caller: library/cipher.c
2234 *
2235 * This module enables the following ciphersuites (if other requisites are
2236 * enabled as well):
2237 *
2238 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2239 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2240 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2241 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2242 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2243 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2244 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2245 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2246 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2248 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2249 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2250 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2251 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2252 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2253 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2254 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2255 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2256 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2257 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2258 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2259 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2262 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2263 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2264 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2265 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2266 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2267 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2268 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2269 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2270 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2271 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2272 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2273 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2274 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2275 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002276 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002277#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002278
2279/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002281 *
2282 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2283 *
2284 * Module: library/ccm.c
2285 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002286 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2287 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002288 *
2289 * This module enables the AES-CCM ciphersuites, if other requisites are
2290 * enabled as well.
2291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002293
2294/**
Daniel King34b822c2016-05-15 17:28:08 -03002295 * \def MBEDTLS_CHACHA20_C
2296 *
2297 * Enable the ChaCha20 stream cipher.
2298 *
2299 * Module: library/chacha20.c
2300 */
2301#define MBEDTLS_CHACHA20_C
2302
2303/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002304 * \def MBEDTLS_CHACHAPOLY_C
2305 *
2306 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2307 *
2308 * Module: library/chachapoly.c
2309 *
2310 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2311 */
2312#define MBEDTLS_CHACHAPOLY_C
2313
2314/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002315 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002316 *
2317 * Enable the generic cipher layer.
2318 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002319 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002320 * Caller: library/ccm.c
2321 * library/cmac.c
2322 * library/gcm.c
2323 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002324 * library/pkcs12.c
2325 * library/pkcs5.c
2326 * library/psa_crypto_aead.c
2327 * library/psa_crypto_mac.c
2328 * library/ssl_ciphersuites.c
2329 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002330 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002331 *
2332 * Uncomment to enable generic cipher wrappers.
2333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002335
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002336/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002337 * \def MBEDTLS_CMAC_C
2338 *
Simon Butcher327398a2016-10-05 14:09:11 +01002339 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2340 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002341 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002342 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2343 * implementation of the CMAC algorithm is provided by an alternate
2344 * implementation, that alternate implementation may opt to not support
2345 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2346 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002347 * Module: library/cmac.c
2348 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002349 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002350 *
2351 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002352#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002353
2354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002355 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002356 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002357 * Enable the CTR_DRBG AES-based random generator.
2358 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002359 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002360 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002361 * \note To achieve a 256-bit security strength with CTR_DRBG,
2362 * you must use AES-256 *and* use sufficient entropy.
2363 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002364 *
2365 * Module: library/ctr_drbg.c
2366 * Caller:
2367 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002369 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002370 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002372#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002373
2374/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002376 *
2377 * Enable the debug functions.
2378 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002379 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002380 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002381 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002382 * library/ssl_tls12_*.c
2383 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002384 *
2385 * This module provides debugging functions.
2386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002388
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002389/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002391 *
2392 * Enable the DES block cipher.
2393 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002394 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002395 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002396 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002397 *
Paul Bakkercff68422013-09-15 20:43:33 +02002398 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002399 *
2400 * \warning DES is considered a weak cipher and its use constitutes a
2401 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002404
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002407 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002408 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002409 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002410 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002411 * Caller: library/ssl_tls.c
2412 * library/ssl*_client.c
2413 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002414 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002415 * This module is used by the following key exchanges:
2416 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002417 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002418 * \warning Using DHE constitutes a security risk as it
2419 * is not possible to validate custom DH parameters.
2420 * If possible, it is recommended users should consider
2421 * preferring other methods of key exchange.
2422 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002423 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002425#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002426
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002427/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002428 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002429 *
2430 * Enable the elliptic curve Diffie-Hellman library.
2431 *
2432 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002433 * Caller: library/psa_crypto.c
2434 * library/ssl_tls.c
2435 * library/ssl*_client.c
2436 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002437 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002438 * This module is used by the following key exchanges:
2439 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002440 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002441 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002444
2445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002447 *
2448 * Enable the elliptic curve DSA library.
2449 *
2450 * Module: library/ecdsa.c
2451 * Caller:
2452 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002453 * This module is used by the following key exchanges:
2454 * ECDHE-ECDSA
2455 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002456 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2457 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2458 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002459 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002460#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002461
2462/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002463 * \def MBEDTLS_ECJPAKE_C
2464 *
2465 * Enable the elliptic curve J-PAKE library.
2466 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002467 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2468 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002469 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002470 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002471 * Module: library/ecjpake.c
2472 * Caller:
2473 *
2474 * This module is used by the following key exchanges:
2475 * ECJPAKE
2476 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002477 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002478 *
2479 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2480 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002481 *
2482 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002483 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002484 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2485 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002486 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002487#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002488
2489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002491 *
2492 * Enable the elliptic curve over GF(p) library.
2493 *
2494 * Module: library/ecp.c
2495 * Caller: library/ecdh.c
2496 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002497 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002498 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002500 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002501#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002502
2503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002504 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002505 *
2506 * Enable the platform-specific entropy code.
2507 *
2508 * Module: library/entropy.c
2509 * Caller:
2510 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002512 *
2513 * This module provides a generic entropy pool
2514 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002516
2517/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002519 *
2520 * Enable error code to error string conversion.
2521 *
2522 * Module: library/error.c
2523 * Caller:
2524 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002525 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002528
2529/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002530 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002531 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002532 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002533 *
2534 * Module: library/gcm.c
2535 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002536 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2537 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002538 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002539 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2540 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002543
2544/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002545 * \def MBEDTLS_HKDF_C
2546 *
2547 * Enable the HKDF algorithm (RFC 5869).
2548 *
2549 * Module: library/hkdf.c
2550 * Caller:
2551 *
2552 * Requires: MBEDTLS_MD_C
2553 *
2554 * This module adds support for the Hashed Message Authentication Code
2555 * (HMAC)-based key derivation function (HKDF).
2556 */
2557#define MBEDTLS_HKDF_C
2558
2559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002561 *
2562 * Enable the HMAC_DRBG random generator.
2563 *
2564 * Module: library/hmac_drbg.c
2565 * Caller:
2566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002568 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002569 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002572
2573/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002574 * \def MBEDTLS_LMS_C
2575 *
2576 * Enable the LMS stateful-hash asymmetric signature algorithm.
2577 *
2578 * Module: library/lms.c
2579 * Caller:
2580 *
Raef Colesab4f8742022-09-01 12:24:31 +01002581 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002582 *
Raef Colesab4f8742022-09-01 12:24:31 +01002583 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002584 */
2585#define MBEDTLS_LMS_C
2586
2587/**
Raef Colesab4f8742022-09-01 12:24:31 +01002588 * \def MBEDTLS_LMS_PRIVATE
2589 *
2590 * Enable LMS private-key operations and signing code. Functions enabled by this
2591 * option are experimental, and should not be used in production.
2592 *
2593 * Requires: MBEDTLS_LMS_C
2594 *
2595 * Uncomment to enable the LMS signature algorithm and private key operations.
2596 */
Raef Coles5127e852022-10-07 10:35:56 +01002597//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002598
2599/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002600 * \def MBEDTLS_NIST_KW_C
2601 *
2602 * Enable the Key Wrapping mode for 128-bit block ciphers,
2603 * as defined in NIST SP 800-38F. Only KW and KWP modes
2604 * are supported. At the moment, only AES is approved by NIST.
2605 *
2606 * Module: library/nist_kw.c
2607 *
2608 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2609 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002610#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002611
2612/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002614 *
2615 * Enable the generic message digest layer.
2616 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002617 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2618 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2619 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002620 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002621 * Caller: library/constant_time.c
2622 * library/ecdsa.c
2623 * library/ecjpake.c
2624 * library/hkdf.c
2625 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002626 * library/pk.c
2627 * library/pkcs5.c
2628 * library/pkcs12.c
2629 * library/psa_crypto_ecp.c
2630 * library/psa_crypto_rsa.c
2631 * library/rsa.c
2632 * library/ssl_cookie.c
2633 * library/ssl_msg.c
2634 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002635 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002636 * library/x509_crt.c
2637 * library/x509write_crt.c
2638 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002639 *
2640 * Uncomment to enable generic message digest wrappers.
2641 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002642#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002643
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002646 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002647 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002648 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002649 * Module: library/md5.c
2650 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002651 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002652 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002653 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002654 * This module is required for TLS 1.2 depending on the handshake parameters.
2655 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2656 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002657 *
2658 * \warning MD5 is considered a weak message digest and its use constitutes a
2659 * security risk. If possible, we recommend avoiding dependencies on
2660 * it, and considering stronger message digests instead.
2661 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002664
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002665/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002667 *
2668 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002669 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002670 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002671 *
2672 * Module: library/memory_buffer_alloc.c
2673 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674 * Requires: MBEDTLS_PLATFORM_C
2675 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002676 *
2677 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002680
2681/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002682 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002683 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002684 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2685 *
Simon Butcherd567a232016-03-09 20:19:21 +00002686 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2687 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002688 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002689 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002690 * \note See also our Knowledge Base article about porting to a new
2691 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002692 * 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 +00002693 *
Andres AG788aa4a2016-09-14 14:32:09 +01002694 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002695 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002696 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002697 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002699
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002701 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002702 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002703 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002704 *
2705 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002706 * Caller: library/asn1write.c
2707 * library/pkcs5.c
2708 * library/pkparse.c
2709 * library/pkwrite.c
2710 * library/rsa.c
2711 * library/x509.c
2712 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002713 * library/x509_crl.c
2714 * library/x509_crt.c
2715 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002716 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002717 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002718 *
2719 * This modules translates between OIDs and internal values.
2720 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002721#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002722
2723/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002725 *
2726 * Enable VIA Padlock support on x86.
2727 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002728 * Module: library/padlock.c
2729 * Caller: library/aes.c
2730 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002732 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002733 * This modules adds support for the VIA PadLock on x86.
2734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002735#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002736
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002739 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002740 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002741 *
2742 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002743 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002744 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002745 * library/x509_crl.c
2746 * library/x509_crt.c
2747 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002748 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002749 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002750 *
Paul Bakkercff68422013-09-15 20:43:33 +02002751 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002753#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002754
2755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002756 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002757 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002758 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002759 *
2760 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002761 * Caller: library/pkwrite.c
2762 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002763 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002764 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002766 *
2767 * This modules adds support for encoding / writing PEM files.
2768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002770
2771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002773 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002774 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002775 *
2776 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002777 * Caller: library/psa_crypto_rsa.c
2778 * library/ssl_tls.c
2779 * library/ssl*_client.c
2780 * library/ssl*_server.c
2781 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002782 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002783 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002784 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002785 * Uncomment to enable generic public key wrappers.
2786 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002787#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002788
2789/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002791 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002792 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002793 *
2794 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002795 * Caller: library/x509_crt.c
2796 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002799 *
2800 * Uncomment to enable generic public key parse functions.
2801 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002803
2804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002806 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002807 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002808 *
2809 * Module: library/pkwrite.c
2810 * Caller: library/x509write.c
2811 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002812 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002813 *
2814 * Uncomment to enable generic public key write functions.
2815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002817
2818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002820 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002821 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002822 *
2823 * Module: library/pkcs5.c
2824 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002825 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2826 *
2827 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2828 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002829 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002830 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002831 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002832 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2833 * this module in builds where MBEDTLS_MD_C is disabled.
2834 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002835 * This module adds support for the PKCS#5 functions.
2836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002838
2839/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002840 * \def MBEDTLS_PKCS7_C
2841 *
Dave Rodgmandbcbf442022-12-05 11:15:10 +00002842 * This feature is a work in progress and not ready for production. Testing and
2843 * validation is incomplete, and handling of malformed inputs may not be robust.
2844 * The API may change.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002845 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002846 * Enable PKCS7 core for using PKCS7 formatted signatures.
2847 * RFC Link - https://tools.ietf.org/html/rfc2315
2848 *
2849 * Module: library/pkcs7.c
2850 *
2851 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002852 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2853 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002854 *
2855 * This module is required for the PKCS7 parsing modules.
2856 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002857//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002858
2859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002862 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002863 * Adds algorithms for parsing PKCS#8 encrypted private keys
2864 *
2865 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002866 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002867 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002868 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2869 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2870 *
2871 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2872 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002873 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002874 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002875 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002876 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2877 * this module in builds where MBEDTLS_MD_C is disabled.
2878 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002879 * This module enables PKCS#12 functions.
2880 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002881#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002882
2883/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002885 *
2886 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002887 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002888 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2890 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002891 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002892 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002893 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002894 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002895 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002896 * Module: library/platform.c
2897 * Caller: Most other .c files
2898 *
2899 * This module enables abstraction of common (libc) functions.
2900 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002901#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002902
2903/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002904 * \def MBEDTLS_POLY1305_C
2905 *
2906 * Enable the Poly1305 MAC algorithm.
2907 *
2908 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002909 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002910 */
2911#define MBEDTLS_POLY1305_C
2912
2913/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002914 * \def MBEDTLS_PSA_CRYPTO_C
2915 *
2916 * Enable the Platform Security Architecture cryptography API.
2917 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002918 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002919 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002920 * Requires: MBEDTLS_CIPHER_C,
2921 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002922 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002923 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002924 *
2925 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002926#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002927
2928/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002929 * \def MBEDTLS_PSA_CRYPTO_SE_C
2930 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002931 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002932 * cryptography API.
2933 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002934 * \deprecated This feature is deprecated. Please switch to the driver
2935 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002936 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002937 * Module: library/psa_crypto_se.c
2938 *
2939 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2940 *
2941 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002942//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002943
2944/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002945 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2946 *
2947 * Enable the Platform Security Architecture persistent key storage.
2948 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002949 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002950 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002951 * Requires: MBEDTLS_PSA_CRYPTO_C,
2952 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2953 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002954 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002955#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002956
2957/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002958 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002959 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002960 * Enable the emulation of the Platform Security Architecture
2961 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002962 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002963 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002964 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002965 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002966 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002967#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002971 *
2972 * Enable the RIPEMD-160 hash algorithm.
2973 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002974 * Module: library/ripemd160.c
2975 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002976 *
2977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002979
2980/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002982 *
2983 * Enable the RSA public-key cryptosystem.
2984 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002985 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002986 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002987 * Caller: library/pk.c
2988 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002989 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002990 * library/ssl*_client.c
2991 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002992 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002993 * This module is used by the following key exchanges:
2994 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002995 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002999
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003000/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003002 *
3003 * Enable the SHA1 cryptographic hash algorithm.
3004 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003005 * Module: library/sha1.c
3006 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003007 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003008 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003009 * This module is required for TLS 1.2 depending on the handshake parameters,
3010 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003011 *
3012 * \warning SHA-1 is considered a weak message digest and its use constitutes
3013 * a security risk. If possible, we recommend avoiding dependencies
3014 * on it, and considering stronger message digests instead.
3015 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003016 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003017#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003018
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003019/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003020 * \def MBEDTLS_SHA224_C
3021 *
3022 * Enable the SHA-224 cryptographic hash algorithm.
3023 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003024 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003025 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003026 *
3027 * Module: library/sha256.c
3028 * Caller: library/md.c
3029 * library/ssl_cookie.c
3030 *
3031 * This module adds support for SHA-224.
3032 */
3033#define MBEDTLS_SHA224_C
3034
3035/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003037 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003038 * Enable the SHA-256 cryptographic hash algorithm.
3039 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003040 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003041 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003042 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003043 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003044 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003045 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003046 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003047 * library/ssl*_client.c
3048 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003049 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003050 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003051 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003054
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003055/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003056 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3057 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003058 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3059 * with the ARMv8 cryptographic extensions if they are available at runtime.
3060 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003061 *
3062 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3063 * for a non-Aarch64 build it will be silently ignored.
3064 *
3065 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3066 * of \c -march=armv8-a+crypto.
3067 *
3068 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3069 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3070 *
3071 * Requires: MBEDTLS_SHA256_C.
3072 *
3073 * Module: library/sha256.c
3074 *
3075 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3076 * and use them if available.
3077 */
3078//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3079
3080/**
3081 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3082 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003083 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3084 * with the ARMv8 cryptographic extensions, which must be available at runtime
3085 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003086 *
3087 * \note This allows builds with a smaller code size than with
3088 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3089 *
3090 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3091 * of \c -march=armv8-a+crypto.
3092 *
3093 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3094 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3095 *
3096 * Requires: MBEDTLS_SHA256_C.
3097 *
3098 * Module: library/sha256.c
3099 *
3100 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3101 * unconditionally.
3102 */
3103//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3104
3105/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003106 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003107 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003108 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003109 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003110 * Requires: MBEDTLS_SHA512_C
3111 *
3112 * Module: library/sha512.c
3113 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003114 * library/psa_crypto_hash.c
3115 * library/ssl_tls.c
3116 * library/ssl*_client.c
3117 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003118 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003119 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003120 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003121#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003122
3123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003124 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003125 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003126 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003127 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003128 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003129 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003130 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003131 * library/ssl_tls.c
3132 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003134 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003136#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003137
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003138/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003139 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3140 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003141 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3142 * with the ARMv8 cryptographic extensions if they are available at runtime.
3143 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003144 *
3145 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3146 * for a non-Aarch64 build it will be silently ignored.
3147 *
3148 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3149 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3150 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3151 * fastest code.
3152 *
3153 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3154 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3155 *
3156 * Requires: MBEDTLS_SHA512_C.
3157 *
3158 * Module: library/sha512.c
3159 *
3160 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3161 * and use them if available.
3162 */
3163//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3164
3165/**
3166 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3167 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003168 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3169 * with the ARMv8 cryptographic extensions, which must be available at runtime
3170 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003171 *
3172 * \note This allows builds with a smaller code size than with
3173 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3174 *
3175 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3176 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3177 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3178 * fastest code.
3179 *
3180 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3181 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3182 *
3183 * Requires: MBEDTLS_SHA512_C.
3184 *
3185 * Module: library/sha512.c
3186 *
3187 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3188 * unconditionally.
3189 */
3190//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3191
3192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003194 *
3195 * Enable simple SSL cache implementation.
3196 *
3197 * Module: library/ssl_cache.c
3198 * Caller:
3199 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003201 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003202#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003203
3204/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003206 *
3207 * Enable basic implementation of DTLS cookies for hello verification.
3208 *
3209 * Module: library/ssl_cookie.c
3210 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003211 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003213
3214/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003215 * \def MBEDTLS_SSL_TICKET_C
3216 *
3217 * Enable an implementation of TLS server-side callbacks for session tickets.
3218 *
3219 * Module: library/ssl_ticket.c
3220 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003221 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003222 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3223 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003224 */
3225#define MBEDTLS_SSL_TICKET_C
3226
3227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003229 *
3230 * Enable the SSL/TLS client code.
3231 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003232 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003233 * Caller:
3234 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003236 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003237 * This module is required for SSL/TLS client support.
3238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003239#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003240
Paul Bakker9a736322012-11-14 12:39:52 +00003241/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003243 *
3244 * Enable the SSL/TLS server code.
3245 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003246 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003247 * Caller:
3248 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003250 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003251 * This module is required for SSL/TLS server support.
3252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003254
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003255/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003257 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003258 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003259 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003260 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003261 * Caller: library/ssl*_client.c
3262 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3265 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003266 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003267 * This module is required for SSL/TLS.
3268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003270
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003271/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003272 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003273 *
3274 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003275 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003276 * contexts are not shared between threads. If you do intend to use contexts
3277 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003278 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003279 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003280 *
3281 * Module: library/threading.c
3282 *
3283 * This allows different threading implementations (self-implemented or
3284 * provided).
3285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286 * You will have to enable either MBEDTLS_THREADING_ALT or
3287 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003288 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003289 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003292
3293/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003295 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003296 * Enable the semi-portable timing interface.
3297 *
Simon Butcherd567a232016-03-09 20:19:21 +00003298 * \note The provided implementation only works on POSIX/Unix (including Linux,
3299 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003300 * module and provide your own implementations of the callbacks needed by
3301 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3302 * your own implementation of the whole module by setting
3303 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003304 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003305 * \note The timing module will include time.h on suitable platforms
3306 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3307 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3308 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003309 * \note See also our Knowledge Base article about porting to a new
3310 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003311 * 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 +00003312 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003313 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003317/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003318 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003319 *
3320 * Enable run-time version information.
3321 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003322 * Module: library/version.c
3323 *
3324 * This module provides run-time version information.
3325 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003327
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003328/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003330 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003331 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003332 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003333 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003334 * Caller: library/x509_crl.c
3335 * library/x509_crt.c
3336 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003337 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003338 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003339 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3340 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003341 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3342 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003343 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003344 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003347
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003348/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003350 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003351 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003352 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003353 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003354 * Caller: library/ssl_tls.c
3355 * library/ssl*_client.c
3356 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003359 *
3360 * This module is required for X.509 certificate parsing.
3361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003363
3364/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003366 *
3367 * Enable X.509 CRL parsing.
3368 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003369 * Module: library/x509_crl.c
3370 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003373 *
3374 * This module is required for X.509 CRL parsing.
3375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003377
3378/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003380 *
3381 * Enable X.509 Certificate Signing Request (CSR) parsing.
3382 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003383 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003384 * Caller: library/x509_crt_write.c
3385 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003387 *
3388 * This module is used for reading X.509 certificate request.
3389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003391
3392/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003394 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003395 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003396 *
3397 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003398 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003399 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003400 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3401 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003402 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3403 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003404 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003405 * This module is the basis for creating X.509 certificates and CSRs.
3406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003408
3409/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 *
3412 * Enable creating X.509 certificates.
3413 *
3414 * Module: library/x509_crt_write.c
3415 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003417 *
3418 * This module is required for X.509 certificate creation.
3419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003421
3422/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003424 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003425 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003426 *
3427 * Module: library/x509_csr_write.c
3428 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003430 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003431 * This module is required for X.509 certificate request writing.
3432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003433#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003434
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003435/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003436
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003437/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003438 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003439 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003440 * This section contains Mbed TLS build settings that are not associated
3441 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003442 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003443 * \{
3444 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003445
Gilles Peskinea02c1242022-03-16 17:03:19 +01003446/**
3447 * \def MBEDTLS_CONFIG_FILE
3448 *
3449 * If defined, this is a header which will be included instead of
3450 * `"mbedtls/mbedtls_config.h"`.
3451 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003452 * Unlike other configuration options, this one must be defined on the
3453 * compiler command line: a definition in `mbedtls_config.h` would have
3454 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003455 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003456 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003457 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003458 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003459 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003460 * The value of this symbol is typically a path in double quotes, either
3461 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003462 */
3463//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3464
3465/**
3466 * \def MBEDTLS_USER_CONFIG_FILE
3467 *
3468 * If defined, this is a header which will be included after
3469 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003470 * This allows you to modify the default configuration, including the ability
3471 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003472 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003473 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003474 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003475 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003476 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003477 * The value of this symbol is typically a path in double quotes, either
3478 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003479 */
3480//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3481
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003482/**
3483 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3484 *
3485 * If defined, this is a header which will be included instead of
3486 * `"psa/crypto_config.h"`.
3487 * This header file specifies which cryptographic mechanisms are available
3488 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3489 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3490 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003491 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003492 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003493 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003494 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003495 * The value of this symbol is typically a path in double quotes, either
3496 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003497 */
3498//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3499
3500/**
3501 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3502 *
3503 * If defined, this is a header which will be included after
3504 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003505 * This allows you to modify the default configuration, including the ability
3506 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003507 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003508 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003509 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003510 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003511 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003512 * The value of this symbol is typically a path in double quotes, either
3513 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003514 */
3515//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3516
Gilles Peskineba4162a2022-04-11 17:04:38 +02003517/** \} name SECTION: General configuration options */
3518
3519/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003520 * \name SECTION: Module configuration options
3521 *
3522 * This section allows for the setting of module specific sizes and
3523 * configuration options. The default values are already present in the
3524 * relevant header files and should suffice for the regular use cases.
3525 *
3526 * Our advice is to enable options and change their values here
3527 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003528 * \{
3529 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003530/* The Doxygen documentation here is used when a user comments out a
3531 * setting and runs doxygen themselves. On the other hand, when we typeset
3532 * the full documentation including disabled settings, the documentation
3533 * in specific modules' header files is used if present. When editing this
3534 * file, make sure that each option is documented in exactly one place,
3535 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3536 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003537
Paul Bakker088c5c52014-04-25 11:11:10 +02003538/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003539//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003540//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003541
Paul Bakker088c5c52014-04-25 11:11:10 +02003542/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3544//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3545//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3546//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3547//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003548
Paul Bakker088c5c52014-04-25 11:11:10 +02003549/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003550//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3551//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3552//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3553//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003554
Paul Bakker088c5c52014-04-25 11:11:10 +02003555/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003556//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003557//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003558
Paul Bakker088c5c52014-04-25 11:11:10 +02003559/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3561//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003562//#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 +01003563
Paul Bakker088c5c52014-04-25 11:11:10 +02003564/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003566
Paul Bakker088c5c52014-04-25 11:11:10 +02003567/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568//#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 +02003569//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003570//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003571//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003573//#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 +02003574//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3575//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003576/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003578//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3579//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003580//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3581//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3582//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003584/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3585/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003586//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3588//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003589//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003590//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3591//#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 +02003592//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3593//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003594/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003595//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003596//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003597//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3598//#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 +02003599
Gilles Peskine3f106f72021-09-23 17:42:39 +02003600/** \def MBEDTLS_CHECK_RETURN
3601 *
3602 * This macro is used at the beginning of the declaration of a function
3603 * to indicate that its return value should be checked. It should
3604 * instruct the compiler to emit a warning or an error if the function
3605 * is called without checking its return value.
3606 *
3607 * There is a default implementation for popular compilers in platform_util.h.
3608 * You can override the default implementation by defining your own here.
3609 *
3610 * If the implementation here is empty, this will effectively disable the
3611 * checking of functions' return values.
3612 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003613//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003614
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003615/** \def MBEDTLS_IGNORE_RETURN
3616 *
3617 * This macro requires one argument, which should be a C function call.
3618 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3619 * warning is suppressed.
3620 */
3621//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3622
Gilles Peskineed038902020-11-13 21:33:21 +01003623/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003624/**
Gilles Peskineed038902020-11-13 21:33:21 +01003625 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3626 * PSA crypto subsystem.
3627 *
3628 * If this option is unset:
3629 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003630 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003631 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3632 * on unspecified heuristics.
3633 */
3634//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3635
Steven Cooreman863470a2021-02-15 14:03:19 +01003636/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003637 * Restrict the PSA library to supporting a maximum amount of simultaneously
3638 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3639 * volatile key, or a persistent key which is loaded temporarily by the
3640 * library as part of a crypto operation in flight.
3641 *
3642 * If this option is unset, the library will fall back to a default value of
3643 * 32 keys.
3644 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003645//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003646
Paul Bakker088c5c52014-04-25 11:11:10 +02003647/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003648//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3649//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003650
Paul Bakker088c5c52014-04-25 11:11:10 +02003651/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003652
Angus Grattond8213d02016-05-25 20:56:48 +10003653/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3654 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003655 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003656 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003657 * This determines the size of the incoming TLS I/O buffer in such a way
3658 * that it is capable of holding the specified amount of plaintext data,
3659 * regardless of the protection mechanism used.
3660 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003661 * \note When using a value less than the default of 16KB on the client, it is
3662 * recommended to use the Maximum Fragment Length (MFL) extension to
3663 * inform the server about this limitation. On the server, there
3664 * is no supported, standardized way of informing the client about
3665 * restriction on the maximum size of incoming messages, and unless
3666 * the limitation has been communicated by other means, it is recommended
3667 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3668 * while keeping the default value of 16KB for the incoming buffer.
3669 *
David Horstmann95d516f2021-05-04 18:36:56 +01003670 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003671 */
3672//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3673
Gilles Peskined3d02902020-03-04 21:35:27 +01003674/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3675 *
3676 * The maximum length of CIDs used for incoming DTLS messages.
3677 *
3678 */
3679//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3680
3681/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3682 *
3683 * The maximum length of CIDs used for outgoing DTLS messages.
3684 *
3685 */
3686//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3687
TRodziewicze8dd7092021-05-12 14:19:11 +02003688/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003689 *
3690 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003691 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003692 *
3693 * The padding will always be chosen so that the length of the
3694 * padded plaintext is a multiple of the value of this option.
3695 *
3696 * Note: A value of \c 1 means that no padding will be used
3697 * for outgoing records.
3698 *
3699 * Note: On systems lacking division instructions,
3700 * a power of two should be preferred.
3701 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003702//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003703
Angus Grattond8213d02016-05-25 20:56:48 +10003704/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3705 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003706 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003707 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003708 * This determines the size of the outgoing TLS I/O buffer in such a way
3709 * that it is capable of holding the specified amount of plaintext data,
3710 * regardless of the protection mechanism used.
3711 *
Angus Grattond8213d02016-05-25 20:56:48 +10003712 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3713 * the default inward 16384 byte buffer to conform to the TLS specification.
3714 *
3715 * The minimum required outward buffer size is determined by the handshake
3716 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3717 * The specific size requirement depends on the configured ciphers and any
3718 * certificate data which is sent during the handshake.
3719 *
David Horstmann95d516f2021-05-04 18:36:56 +01003720 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003721 */
3722//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3723
Hanno Beckere0b150f2018-08-21 15:51:03 +01003724/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3725 *
3726 * Maximum number of heap-allocated bytes for the purpose of
3727 * DTLS handshake message reassembly and future message buffering.
3728 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003729 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003730 * to account for a reassembled handshake message of maximum size,
3731 * together with its reassembly bitmap.
3732 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003733 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003734 * should be sufficient for all practical situations as it allows
3735 * to reassembly a large handshake message (such as a certificate)
3736 * while buffering multiple smaller handshake messages.
3737 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003738 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003739//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003740
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003741//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3742//#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 +02003743
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003744/**
3745 * Complete list of ciphersuites to use, in order of preference.
3746 *
3747 * \warning No dependency checking is done on that field! This option can only
3748 * be used to restrict the set of available ciphersuites. It is your
3749 * responsibility to make sure the needed modules are active.
3750 *
3751 * Use this to save a few hundred bytes of ROM (default ordering of all
3752 * available ciphersuites) and a few to a few hundred bytes of RAM.
3753 *
3754 * The value below is only an example, not the default.
3755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003756//#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 +02003757
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003758/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003759//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003760//#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 +01003761
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003762/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003763 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003764 * mbedtls_platform_zeroize(). This replaces the default implementation in
3765 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003766 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003767 * mbedtls_platform_zeroize() is a widely used function across the library to
3768 * zero a block of memory. The implementation is expected to be secure in the
3769 * sense that it has been written to prevent the compiler from removing calls
3770 * to mbedtls_platform_zeroize() as part of redundant code elimination
3771 * optimizations. However, it is difficult to guarantee that calls to
3772 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3773 * versions of the C language standards do not provide a secure implementation
3774 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3775 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003776 * example by using directives specific to their compiler, features from newer
3777 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003778 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003779 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003780//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003781
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003782/**
3783 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003784 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003785 * platform_util.c.
3786 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003787 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003788 * library will try to use safer implementations of this function, such as
3789 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003790 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003791 * using the standard gmtime(). In this case, calls from the library to
3792 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003793 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003794 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003795 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3796 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3797 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003798 */
Hanno Becker6a739782018-09-05 15:06:19 +01003799//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003800
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003801/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003802 * Enable the verified implementations of ECDH primitives from Project Everest
3803 * (currently only Curve25519). This feature changes the layout of ECDH
3804 * contexts and therefore is a compatibility break for applications that access
3805 * fields of a mbedtls_ecdh_context structure directly. See also
3806 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003807 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003808//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003809
Gilles Peskine611179c2022-04-13 23:04:48 +02003810/** \} name SECTION: Module configuration options */