blob: 219dd4539ea9325827c2770ab87ec040be7139ee [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 *
Manuel Pégourié-Gonnardad27b802022-12-05 12:54:11 +0100710 * TODO: document interation with USE_PSA_CRYPTO
711 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100712 * \note In the cases above, the usual SSL/TLS functions, such as
713 * mbedtls_ssl_handshake(), can now return
714 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200715 *
Ron Eldor19779c42018-11-05 16:58:13 +0200716 * \note This option only works with the default software implementation of
717 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100718 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT,
719 * and MBEDTLS_USE_PSA_CRYPTO.
720 *
721 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100722 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200723//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100724
725/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200726 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100727 *
728 * Enable deterministic ECDSA (RFC 6979).
729 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
730 * may result in a compromise of the long-term signing key. This is avoided by
731 * the deterministic variant.
732 *
John Durkop36a82e52020-10-26 09:39:05 -0700733 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100734 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100735 * Comment this macro to disable deterministic ECDSA.
736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100738
739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200741 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200742 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200743 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200744 * This enables the following ciphersuites (if other requisites are
745 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
747 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
748 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
749 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
750 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
751 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
752 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
753 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
755 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200757#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200758
759/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200760 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200762 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200764 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200765 *
766 * This enables the following ciphersuites (if other requisites are
767 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
769 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
770 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
771 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
772 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
773 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
777 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100778 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100779 * \warning Using DHE constitutes a security risk as it
780 * is not possible to validate custom DH parameters.
781 * If possible, it is recommended users should consider
782 * preferring other methods of key exchange.
783 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100784 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200787
788/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200790 *
791 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
792 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200794 *
795 * This enables the following ciphersuites (if other requisites are
796 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
798 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
799 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
800 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
801 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
802 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200803 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200804#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200805
806/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200808 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200809 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200810 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
812 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
814 * This enables the following ciphersuites (if other requisites are
815 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
817 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
818 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
819 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
820 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
825 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200826 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200827#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200828
829/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200830 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200832 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
835 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
837 * This enables the following ciphersuites (if other requisites are
838 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
840 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
841 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
842 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
843 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
844 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
845 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
846 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
847 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
850 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200852#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200853
854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200857 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
860 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
862 * This enables the following ciphersuites (if other requisites are
863 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
865 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
866 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
867 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
868 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
869 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
872 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
875 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100876 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100877 * \warning Using DHE constitutes a security risk as it
878 * is not possible to validate custom DH parameters.
879 * If possible, it is recommended users should consider
880 * preferring other methods of key exchange.
881 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100882 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200883 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200884#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200885
886/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200889 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
892 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 *
894 * This enables the following ciphersuites (if other requisites are
895 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
897 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
898 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
899 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
900 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200908
909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200911 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200912 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200914 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200915 *
916 * This enables the following ciphersuites (if other requisites are
917 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
919 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
921 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
922 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200928 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200929#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200930
931/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200932 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100933 *
934 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
935 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200936 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100937 *
938 * This enables the following ciphersuites (if other requisites are
939 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
941 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
942 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
943 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
944 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200951#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100952
953/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100955 *
956 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
957 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200958 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100959 *
960 * This enables the following ciphersuites (if other requisites are
961 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
963 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
964 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
965 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
966 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
967 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
968 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
969 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
970 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
971 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100974
975/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200976 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
977 *
978 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
979 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200980 * \warning This is currently experimental. EC J-PAKE support is based on the
981 * Thread v1.0.0 specification; incompatible changes to the specification
982 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200983 *
984 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200985 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200986 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
987 *
988 * This enables the following ciphersuites (if other requisites are
989 * enabled as well):
990 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
991 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200992//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200993
994/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100996 *
997 * Enhance support for reading EC keys using variants of SEC1 not allowed by
998 * RFC 5915 and RFC 5480.
999 *
1000 * Currently this means parsing the SpecifiedECDomain choice of EC
1001 * parameters (only known groups are supported, not arbitrary domains, to
1002 * avoid validation issues).
1003 *
1004 * Disable if you only need to support RFC 5915 + 5480 key formats.
1005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001007
1008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001010 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * Enable a dummy error function to make use of mbedtls_strerror() in
1012 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1013 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001014 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1016 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001017 *
1018 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001020 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001022
1023/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001025 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001026 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001027 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001031
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001032/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001034 *
1035 * Enable functions that use the filesystem.
1036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001037#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001038
1039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001041 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001042 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001043 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001044 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001045 * application.
1046 *
1047 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001048 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001050
1051/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001053 *
1054 * Do not use built-in platform entropy functions.
1055 * This is useful if your platform does not support
1056 * standards like the /dev/urandom or Windows CryptoAPI.
1057 *
1058 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001060//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001061
1062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001064 *
1065 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1066 * default SHA-512 based one (if both are available).
1067 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001069 *
1070 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1071 * if you have performance concerns.
1072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * This option is only useful if both MBEDTLS_SHA256_C and
1074 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001075 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001076//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001077
1078/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001079 * \def MBEDTLS_ENTROPY_NV_SEED
1080 *
1081 * Enable the non-volatile (NV) seed file-based entropy source.
1082 * (Also enables the NV seed read/write functions in the platform layer)
1083 *
1084 * This is crucial (if not required) on systems that do not have a
1085 * cryptographic entropy source (in hardware or kernel) available.
1086 *
1087 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1088 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001089 * \note The read/write functions that are used by the entropy source are
1090 * determined in the platform layer, and can be modified at runtime and/or
1091 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1092 *
1093 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001094 * with regular fopen(), please make sure you make a seedfile with the
1095 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1096 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001097 * and written to or you will get an entropy source error! The default
1098 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1099 * bytes from the file.
1100 *
1101 * \note The entropy collector will write to the seed file before entropy is
1102 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001103 */
1104//#define MBEDTLS_ENTROPY_NV_SEED
1105
Ronald Cron71016a92020-08-28 19:01:50 +02001106/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001107 *
Ronald Cron71016a92020-08-28 19:01:50 +02001108 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001109 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001110 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1111 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001112 *
1113 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001114 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001115 */
Ronald Cron71016a92020-08-28 19:01:50 +02001116//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001117
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001120 *
1121 * Enable debugging of buffer allocator memory issues. Automatically prints
1122 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1123 * function for 'debug output' of allocated memory.
1124 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001125 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001126 *
1127 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001130
1131/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001132 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001133 *
1134 * Include backtrace information with each allocated block.
1135 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001136 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001137 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001138 *
1139 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001140 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001142
1143/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001145 *
1146 * Support external private RSA keys (eg from a HSM) in the PK layer.
1147 *
1148 * Comment this macro to disable support for external private RSA keys.
1149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001151
1152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001154 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001155 * Enable support for PKCS#1 v1.5 encoding.
1156 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001157 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001158 *
Paul Bakker48377d92013-08-30 12:06:24 +02001159 * This enables support for PKCS#1 v1.5 operations.
1160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001165 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001166 * Enable support for PKCS#1 v2.1 encoding.
1167 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001168 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1169 *
1170 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1171 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001172 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001173 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001174 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001175 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1176 * this module in builds where MBEDTLS_MD_C is disabled.
1177 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001178 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001181
Steven Cooreman6801f082021-02-19 17:21:22 +01001182/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1183 *
1184 * Enable support for platform built-in keys. If you enable this feature,
1185 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1186 * See the documentation of that function for more information.
1187 *
1188 * Built-in keys are typically derived from a hardware unique key or
1189 * stored in a secure element.
1190 *
1191 * Requires: MBEDTLS_PSA_CRYPTO_C.
1192 *
1193 * \warning This interface is experimental and may change or be removed
1194 * without notice.
1195 */
1196//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1197
Ronald Cron3768ac12021-01-26 16:58:00 +01001198/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1199 *
1200 * Enable support for PSA crypto client.
1201 *
1202 * \note This option allows to include the code necessary for a PSA
1203 * crypto client when the PSA crypto implementation is not included in
1204 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1205 * code to set and get PSA key attributes.
1206 * The development of PSA drivers partially relying on the library to
1207 * fulfill the hardware gaps is another possible usage of this option.
1208 *
1209 * \warning This interface is experimental and may change or be removed
1210 * without notice.
1211 */
1212//#define MBEDTLS_PSA_CRYPTO_CLIENT
1213
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001214/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1215 *
1216 * Enable support for the experimental PSA crypto driver interface.
1217 *
John Durkop185764f2020-10-12 21:32:12 -07001218 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001219 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001220 * \warning This interface is experimental. We intend to maintain backward
1221 * compatibility with application code that relies on drivers,
1222 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001223 */
1224//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1225
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001226/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1227 *
1228 * Make the PSA Crypto module use an external random generator provided
1229 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1230 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001231 * \note This random generator must deliver random numbers with cryptographic
1232 * quality and high performance. It must supply unpredictable numbers
1233 * with a uniform distribution. The implementation of this function
1234 * is responsible for ensuring that the random generator is seeded
1235 * with sufficient entropy. If you have a hardware TRNG which is slow
1236 * or delivers non-uniform output, declare it as an entropy source
1237 * with mbedtls_entropy_add_source() instead of enabling this option.
1238 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001239 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001240 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1241 * and define a function called mbedtls_psa_external_get_random()
1242 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001243 * ```
1244 * psa_status_t mbedtls_psa_external_get_random(
1245 * mbedtls_psa_external_random_context_t *context,
1246 * uint8_t *output, size_t output_size, size_t *output_length);
1247 * );
1248 * ```
1249 * The \c context value is initialized to 0 before the first call.
1250 * The function must fill the \c output buffer with \p output_size bytes
1251 * of random data and set \c *output_length to \p output_size.
1252 *
1253 * Requires: MBEDTLS_PSA_CRYPTO_C
1254 *
1255 * \warning If you enable this option, code that uses the PSA cryptography
1256 * interface will not use any of the entropy sources set up for
1257 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1258 * enables.
1259 *
1260 * \note This option is experimental and may be removed without notice.
1261 */
1262//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1263
Paul Bakker9dcc3222011-03-08 14:16:06 +00001264/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001265 * \def MBEDTLS_PSA_CRYPTO_SPM
1266 *
1267 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1268 * Partition Manager) integration which separates the code into two parts: a
1269 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1270 * Environment).
1271 *
1272 * Module: library/psa_crypto.c
1273 * Requires: MBEDTLS_PSA_CRYPTO_C
1274 *
1275 */
1276//#define MBEDTLS_PSA_CRYPTO_SPM
1277
1278/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001279 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001280 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001281 * Enable support for entropy injection at first boot. This feature is
1282 * required on systems that do not have a built-in entropy source (TRNG).
1283 * This feature is currently not supported on systems that have a built-in
1284 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001287 *
1288 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001289//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290
1291/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001292 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001293 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001294 * Do not use the Chinese Remainder Theorem
1295 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001296 *
1297 * Uncomment this macro to disable the use of CRT in RSA.
1298 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001301
1302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001304 *
1305 * Enable the checkup functions (*_self_test).
1306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001308
1309/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001310 * \def MBEDTLS_SHA256_SMALLER
1311 *
1312 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1313 * lower performance.
1314 *
Adam Wolf039080f2019-09-10 09:53:08 -05001315 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001316 * performance and size. This version optimizes more aggressively for size at
1317 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1318 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1319 * 30%.
1320 *
1321 * Uncomment to enable the smaller implementation of SHA256.
1322 */
1323//#define MBEDTLS_SHA256_SMALLER
1324
1325/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001326 * \def MBEDTLS_SHA512_SMALLER
1327 *
1328 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1329 * lower performance.
1330 *
1331 * Uncomment to enable the smaller implementation of SHA512.
1332 */
1333//#define MBEDTLS_SHA512_SMALLER
1334
1335/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001337 *
1338 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001339 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001340 * with other servers, only debugging of failures is harder.
1341 *
1342 * The advantage of not sending alert messages, is that no information is given
1343 * about reasons for failures thus preventing adversaries of gaining intel.
1344 *
1345 * Enable sending of all alert messages
1346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001348
1349/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001350 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1351 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001352 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001353 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001354 * in the underlying transport. The CID functionality is described
1355 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001356 *
1357 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001358 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1359 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1360 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001361 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001362 * The maximum lengths of outgoing and incoming CIDs can be configured
1363 * through the options
1364 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1365 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1366 *
1367 * Requires: MBEDTLS_SSL_PROTO_DTLS
1368 *
1369 * Uncomment to enable the Connection ID extension.
1370 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001371#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1372
1373
1374/**
1375 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1376 *
1377 * Defines whether RFC 9146 (default) or the legacy version
1378 * (version draft-ietf-tls-dtls-connection-id-05,
1379 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1380 * is used.
1381 *
1382 * Set the value to 0 for the standard version, and
1383 * 1 for the legacy draft version.
1384 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001385 * \deprecated Support for the legacy version of the DTLS
1386 * Connection ID feature is deprecated. Please
1387 * switch to the standardized version defined
1388 * in RFC 9146 enabled by utilizing
1389 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1390 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1391 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001392 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1393 */
1394#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001395
1396/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001397 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1398 *
1399 * Enable asynchronous external private key operations in SSL. This allows
1400 * you to configure an SSL connection to call an external cryptographic
1401 * module to perform private key operations instead of performing the
1402 * operation inside the library.
1403 *
1404 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001405//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001406
1407/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001408 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1409 *
1410 * Enable serialization of the TLS context structures, through use of the
1411 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1412 *
1413 * This pair of functions allows one side of a connection to serialize the
1414 * context associated with the connection, then free or re-use that context
1415 * while the serialized state is persisted elsewhere, and finally deserialize
1416 * that state to a live context for resuming read/write operations on the
1417 * connection. From a protocol perspective, the state of the connection is
1418 * unaffected, in particular this is entirely transparent to the peer.
1419 *
1420 * Note: this is distinct from TLS session resumption, which is part of the
1421 * protocol and fully visible by the peer. TLS session resumption enables
1422 * establishing new connections associated to a saved session with shorter,
1423 * lighter handshakes, while context serialization is a local optimization in
1424 * handling a single, potentially long-lived connection.
1425 *
1426 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1427 * saved after the handshake to allow for more efficient serialization, so if
1428 * you don't need this feature you'll save RAM by disabling it.
1429 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001430 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1431 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001432 * Comment to disable the context serialization APIs.
1433 */
1434#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1435
1436/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001438 *
1439 * Enable the debug messages in SSL module for all issues.
1440 * Debug messages have been disabled in some places to prevent timing
1441 * attacks due to (unbalanced) debugging function calls.
1442 *
1443 * If you need all error reporting you should enable this during debugging,
1444 * but remove this for production servers that should log as well.
1445 *
1446 * Uncomment this macro to report all debug messages on errors introducing
1447 * a timing side-channel.
1448 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001450//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001451
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001452/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001453 *
1454 * Enable support for Encrypt-then-MAC, RFC 7366.
1455 *
1456 * This allows peers that both support it to use a more robust protection for
1457 * ciphersuites using CBC, providing deep resistance against timing attacks
1458 * on the padding or underlying cipher.
1459 *
1460 * This only affects CBC ciphersuites, and is useless if none is defined.
1461 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001462 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001463 *
1464 * Comment this macro to disable support for Encrypt-then-MAC
1465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001467
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001468/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001469 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001470 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1471 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001472 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001473 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001474 * attacks, but it is recommended to always use it (even if you disable
1475 * renegotiation), since it actually fixes a more fundamental issue in the
1476 * original SSL/TLS design, and has implications beyond Triple Handshake.
1477 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001478 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001479 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001480 * Comment this macro to disable support for Extended Master Secret.
1481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001483
Paul Bakkerd66f0702013-01-31 16:57:45 +01001484/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001485 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1486 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001487 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001488 * giving access to the peer's certificate after completion of the handshake.
1489 *
1490 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1491 * recommended to disable this option for reduced RAM usage.
1492 *
1493 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1494 * defined, but always returns \c NULL.
1495 *
1496 * \note This option has no influence on the protection against the
1497 * triple handshake attack. Even if it is disabled, Mbed TLS will
1498 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001499 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001500 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001501 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1502 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001503 * Comment this macro to disable storing the peer's certificate
1504 * after the handshake.
1505 */
1506#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1507
1508/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001510 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001511 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001512 *
1513 * The two main uses of renegotiation are (1) refresh keys on long-lived
1514 * connections and (2) client authentication after the initial handshake.
1515 * If you don't need renegotiation, it's probably better to disable it, since
1516 * it has been associated with security issues in the past and is easy to
1517 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001518 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001519 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001520 *
1521 * \note Even if this option is disabled, both client and server are aware
1522 * of the Renegotiation Indication Extension (RFC 5746) used to
1523 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1524 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1525 * configuration of this extension).
1526 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001529
1530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001532 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001533 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001534 *
1535 * Comment this macro to disable support for the max_fragment_length extension
1536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001537#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001538
1539/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001541 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001542 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001543 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001544 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1545 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1546 * With MBEDTLS_USE_PSA_CRYPTO:
1547 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1548 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001549 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001550 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1551 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001552 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001553 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001556
1557/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001558 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001559 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001560 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001561 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001562 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1563 * pre-shared keys are not supported.
1564 * See docs/architecture/tls13-support.md for a description of the TLS
1565 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001566 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001567 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001568 * Requires: MBEDTLS_PSA_CRYPTO_C
1569 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001570 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1571 * for most operations, if you want it to only use PSA for all crypto
1572 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1573 * operations, and functions that are common with TLS 1.2 (record protection,
1574 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001575 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001576 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001577 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001578//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001579
1580/**
Ronald Cronab65c522021-11-24 10:47:20 +01001581 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1582 *
1583 * Enable TLS 1.3 middlebox compatibility mode.
1584 *
1585 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1586 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1587 * expecting TLS 1.2 traffic.
1588 *
1589 * Turning on the compatibility mode comes at the cost of a few added bytes
1590 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1591 * that don't use it. Therefore, unless transmission bandwidth is critical and
1592 * you know that middlebox compatibility issues won't occur, it is therefore
1593 * recommended to set this option.
1594 *
1595 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001596 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1597 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001598 *
1599 */
1600//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1601
1602/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001603 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1604 *
1605 * Enable TLS 1.3 PSK key exchange mode.
1606 *
1607 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1608 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1609 * effect on the build.
1610 *
1611 */
1612#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1613
1614/**
1615 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1616 *
1617 * Enable TLS 1.3 ephemeral key exchange mode.
1618 *
1619 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1620 * MBEDTLS_PKCS1_V21
1621 *
1622 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1623 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1624 * effect on the build.
1625 *
1626 */
1627#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1628
1629/**
1630 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1631 *
1632 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1633 *
1634 * Requires: MBEDTLS_ECDH_C
1635 *
1636 * Comment to disable support for the PSK ephemeral key exchange mode in
1637 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1638 * have any effect on the build.
1639 *
1640 */
1641#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1642
1643/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001644 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001645 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001646 * Maximum time difference in milliseconds tolerated between the age of a
1647 * ticket from the server and client point of view.
1648 * From the client point of view, the age of a ticket is the time difference
1649 * between the time when the client proposes to the server to use the ticket
1650 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1651 * the time the client received the ticket from the server.
1652 * From the server point of view, the age of a ticket is the time difference
1653 * between the time when the server receives a proposition from the client
1654 * to use the ticket and the time when the ticket was created by the server.
1655 * The server age is expected to be always greater than the client one and
1656 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1657 * maximum difference tolerated for the server to accept the ticket.
1658 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001659 *
1660 */
1661#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1662
1663/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001664 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1665 *
1666 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1667 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001668 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001669 */
Jerry Yu9750f812022-07-20 11:04:50 +08001670#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001671
1672/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001673 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1674 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001675 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1676 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1677 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001678 *
1679 */
1680#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1681
1682/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001683* \def MBEDTLS_SSL_EARLY_DATA
1684*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001685* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001686*
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001687* Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1688* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1689* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001690*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001691* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001692* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001693*
1694* This feature is experimental, not completed and thus not ready for
1695* production.
1696*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001697*/
Ronald Cronc2e110f2022-11-22 09:01:46 +01001698//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001699
1700/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001702 *
1703 * Enable support for DTLS (all available versions).
1704 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001705 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001706 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001707 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001708 *
1709 * Comment this macro to disable support for DTLS
1710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001712
1713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001715 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001716 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001717 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001718 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001721
1722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001724 *
1725 * Enable support for the anti-replay mechanism in DTLS.
1726 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001727 * Requires: MBEDTLS_SSL_TLS_C
1728 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001729 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001730 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001731 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001732 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001733 * Comment this to disable anti-replay in DTLS.
1734 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001735#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001736
1737/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001739 *
1740 * Enable support for HelloVerifyRequest on DTLS servers.
1741 *
1742 * This feature is highly recommended to prevent DTLS servers being used as
1743 * amplifiers in DoS attacks against other hosts. It should always be enabled
1744 * unless you know for sure amplification cannot be a problem in the
1745 * environment in which your server operates.
1746 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001747 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001748 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001749 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001750 *
1751 * Comment this to disable support for HelloVerifyRequest.
1752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001753#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001754
1755/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001756 * \def MBEDTLS_SSL_DTLS_SRTP
1757 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001758 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001759 * through the use_srtp extension.
1760 *
1761 * \note This feature provides the minimum functionality required
1762 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1763 * the associated SRTP packet protection key material.
1764 * In particular, the SRTP packet protection itself, as well as the
1765 * demultiplexing of RTP and DTLS packets at the datagram layer
1766 * (see Section 5 of RFC 5764), are not handled by this feature.
1767 * Instead, after successful completion of a handshake negotiating
1768 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001769 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001770 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1771 * (this is implemented in the SSL example programs).
1772 * The resulting key should then be passed to an SRTP stack.
1773 *
1774 * Setting this option enables the runtime API
1775 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1776 * through which the supported DTLS-SRTP protection
1777 * profiles can be configured. You must call this API at
1778 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001779 *
1780 * Requires: MBEDTLS_SSL_PROTO_DTLS
1781 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001782 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001783 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001784//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001785
1786/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001787 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1788 *
1789 * Enable server-side support for clients that reconnect from the same port.
1790 *
1791 * Some clients unexpectedly close the connection and try to reconnect using the
1792 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001793 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001794 * flag enables that support.
1795 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001796 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001797 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001798 * Comment this to disable support for clients reusing the source port.
1799 */
1800#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1801
1802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001804 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001805 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001806 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001807 * session store remains the responsibility of the application, though).
1808 * Server-side, you also need to provide callbacks for writing and parsing
1809 * tickets, including authenticated encryption and key management. Example
1810 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001811 *
1812 * Comment this macro to disable support for SSL session tickets
1813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001815
1816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001817 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001818 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001819 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001820 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001821 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001822 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001823 * Comment this macro to disable support for server name indication in SSL
1824 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001825#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001826
1827/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001828 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1829 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001830 * When this option is enabled, the SSL buffer will be resized automatically
1831 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001832 *
1833 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001834 */
1835//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1836
1837/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001838 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1839 *
1840 * Enable testing of the constant-flow nature of some sensitive functions with
1841 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001842 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001844 * This setting requires compiling with clang -fsanitize=memory. The test
1845 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001846 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001847 * \warning This macro is only used for extended testing; it is not considered
1848 * part of the library's API, so it may change or disappear at any time.
1849 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001850 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001851 */
1852//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1853
1854/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001855 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1856 *
1857 * Enable testing of the constant-flow nature of some sensitive functions with
1858 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001859 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001860 *
1861 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001862 * testing if the tests suites are run with valgrind's memcheck. This can be
1863 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1864 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001865 *
1866 * \warning This macro is only used for extended testing; it is not considered
1867 * part of the library's API, so it may change or disappear at any time.
1868 *
1869 * Uncomment to enable testing of the constant-flow nature of selected code.
1870 */
1871//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1872
1873/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001874 * \def MBEDTLS_TEST_HOOKS
1875 *
1876 * Enable features for invasive testing such as introspection functions and
1877 * hooks for fault injection. This enables additional unit tests.
1878 *
1879 * Merely enabling this feature should not change the behavior of the product.
1880 * It only adds new code, and new branching points where the default behavior
1881 * is the same as when this feature is disabled.
1882 * However, this feature increases the attack surface: there is an added
1883 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1884 * Therefore this feature must never be enabled in production.
1885 *
1886 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1887 * information.
1888 *
1889 * Uncomment to enable invasive tests.
1890 */
1891//#define MBEDTLS_TEST_HOOKS
1892
1893/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001894 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001895 *
1896 * Provide your own alternate threading implementation.
1897 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001898 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001899 *
1900 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001903
1904/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001906 *
1907 * Enable the pthread wrapper layer for the threading layer.
1908 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001910 *
1911 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001912 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001914
1915/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001916 * \def MBEDTLS_USE_PSA_CRYPTO
1917 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001918 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1919 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001920 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001921 * \note Development of this option is currently in progress, and parts of Mbed
1922 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001923 * will still continue to work as usual, so enabling this option should not
1924 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001925 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001926 * \note See docs/use-psa-crypto.md for a complete description of what this
1927 * option currently does, and of parts that are not affected by it so far.
1928 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001929 * \warning If you enable this option, you need to call `psa_crypto_init()`
1930 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001931 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001932 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001933 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001934 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001935 */
1936//#define MBEDTLS_USE_PSA_CRYPTO
1937
1938/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001939 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1940 *
John Durkop185764f2020-10-12 21:32:12 -07001941 * This setting allows support for cryptographic mechanisms through the PSA
1942 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001943 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001944 * When this option is disabled, the PSA API exposes the cryptographic
1945 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1946 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001947 *
1948 * When this option is enabled, the PSA API exposes the cryptographic
1949 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1950 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1951 * automatically enabled if required (i.e. if no PSA driver provides the
1952 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1953 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001954 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001955 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001956 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001957 *
John Durkop185764f2020-10-12 21:32:12 -07001958 * This feature is still experimental and is not ready for production since
1959 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001960 */
1961//#define MBEDTLS_PSA_CRYPTO_CONFIG
1962
1963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001965 *
1966 * Allow run-time checking of compile-time enabled features. Thus allowing users
1967 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001969 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001970 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001971 *
1972 * Comment this to disable run-time checking and save ROM space
1973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001975
1976/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001977 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1978 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001979 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001980 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1981 * the set of trusted certificates through a callback instead of a linked
1982 * list.
1983 *
1984 * This is useful for example in environments where a large number of trusted
1985 * certificates is present and storing them in a linked list isn't efficient
1986 * enough, or when the set of trusted certificates changes frequently.
1987 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001988 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001989 * `mbedtls_ssl_conf_ca_cb()` for more information.
1990 *
1991 * Uncomment to enable trusted certificate callbacks.
1992 */
1993//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1994
1995/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001996 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001997 *
Chris Jones2c745862020-12-16 11:41:06 +00001998 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001999 *
Chris Jones2c745862020-12-16 11:41:06 +00002000 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002001 * and other functions/constants only used by these functions, thus reducing
2002 * the code footprint by several KB.
2003 */
Chris Jones2c745862020-12-16 11:41:06 +00002004//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002005
2006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002008 *
2009 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2010 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2011 *
2012 * Comment this macro to disallow using RSASSA-PSS in certificates.
2013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002015/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002016
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002017/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002018 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002019 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002020 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002021 * \{
2022 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002023
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002024/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002026 *
2027 * Enable AES-NI support on x86-64.
2028 *
2029 * Module: library/aesni.c
2030 * Caller: library/aes.c
2031 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002032 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002033 *
2034 * This modules adds support for the AES-NI instructions on x86-64
2035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002037
2038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002040 *
2041 * Enable the AES block cipher.
2042 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002043 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002044 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002045 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002046 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002047 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002048 * This module enables the following ciphersuites (if other requisites are
2049 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2051 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2052 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2053 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2054 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2055 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2056 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2057 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2058 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2059 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2060 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2061 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2062 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2063 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2064 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2065 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2066 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2067 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2068 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2069 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2070 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2071 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2072 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2073 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2074 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2075 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2076 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2077 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2078 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2079 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2080 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2081 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2082 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2083 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2084 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2085 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2086 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2087 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2088 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2089 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2090 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2091 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2092 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2093 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2094 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2095 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2096 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2097 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2098 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2099 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2100 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2101 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2102 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2103 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2104 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2105 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2106 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2107 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002108 *
Paul Bakkercff68422013-09-15 20:43:33 +02002109 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002112
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002113/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002114 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002115 *
2116 * Enable the generic ASN1 parser.
2117 *
2118 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002119 * Caller: library/x509.c
2120 * library/dhm.c
2121 * library/pkcs12.c
2122 * library/pkcs5.c
2123 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002126
2127/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002129 *
2130 * Enable the generic ASN1 writer.
2131 *
2132 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002133 * Caller: library/ecdsa.c
2134 * library/pkwrite.c
2135 * library/x509_create.c
2136 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002137 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002139#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002140
2141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002143 *
2144 * Enable the Base64 module.
2145 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002146 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002147 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002148 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002149 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002152
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002153/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002155 *
Paul Bakker9a736322012-11-14 12:39:52 +00002156 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002157 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002158 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002159 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002160 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002161 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002162 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002163 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002164 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002165 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002166 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002167 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002168 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002169 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002171#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002172
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002173/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002174 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002175 *
2176 * Enable the Camellia block cipher.
2177 *
Paul Bakker38119b12009-01-10 23:31:23 +00002178 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002179 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002180 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002181 * This module enables the following ciphersuites (if other requisites are
2182 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2185 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2186 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2187 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2188 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2189 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2190 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2191 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2192 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2193 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2194 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2195 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2196 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2197 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2198 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2199 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2200 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2201 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2202 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2203 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2204 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2205 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2206 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2207 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2208 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2209 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2210 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2211 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2212 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2213 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2214 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2215 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2216 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2217 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2218 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2219 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2220 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2222 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2223 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2224 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002226#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002227
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002228/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002229 * \def MBEDTLS_ARIA_C
2230 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002231 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002232 *
2233 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002234 * Caller: library/cipher.c
2235 *
2236 * This module enables the following ciphersuites (if other requisites are
2237 * enabled as well):
2238 *
2239 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2240 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2241 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2242 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2243 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2244 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2245 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2246 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2247 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2248 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2249 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2250 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2251 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2252 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2253 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2254 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2255 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2256 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2257 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2258 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2259 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2260 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2261 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2262 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2263 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2264 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2265 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2266 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2267 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2268 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2269 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2270 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2271 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2272 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2273 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2274 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2275 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2276 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002277 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002278#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002279
2280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002282 *
2283 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2284 *
2285 * Module: library/ccm.c
2286 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002287 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2288 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002289 *
2290 * This module enables the AES-CCM ciphersuites, if other requisites are
2291 * enabled as well.
2292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002294
2295/**
Daniel King34b822c2016-05-15 17:28:08 -03002296 * \def MBEDTLS_CHACHA20_C
2297 *
2298 * Enable the ChaCha20 stream cipher.
2299 *
2300 * Module: library/chacha20.c
2301 */
2302#define MBEDTLS_CHACHA20_C
2303
2304/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002305 * \def MBEDTLS_CHACHAPOLY_C
2306 *
2307 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2308 *
2309 * Module: library/chachapoly.c
2310 *
2311 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2312 */
2313#define MBEDTLS_CHACHAPOLY_C
2314
2315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002316 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002317 *
2318 * Enable the generic cipher layer.
2319 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002320 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002321 * Caller: library/ccm.c
2322 * library/cmac.c
2323 * library/gcm.c
2324 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002325 * library/pkcs12.c
2326 * library/pkcs5.c
2327 * library/psa_crypto_aead.c
2328 * library/psa_crypto_mac.c
2329 * library/ssl_ciphersuites.c
2330 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002331 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002332 *
2333 * Uncomment to enable generic cipher wrappers.
2334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002336
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002337/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002338 * \def MBEDTLS_CMAC_C
2339 *
Simon Butcher327398a2016-10-05 14:09:11 +01002340 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2341 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002342 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002343 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2344 * implementation of the CMAC algorithm is provided by an alternate
2345 * implementation, that alternate implementation may opt to not support
2346 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2347 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002348 * Module: library/cmac.c
2349 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002350 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002351 *
2352 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002353#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002354
2355/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002357 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002358 * Enable the CTR_DRBG AES-based random generator.
2359 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002360 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002361 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002362 * \note To achieve a 256-bit security strength with CTR_DRBG,
2363 * you must use AES-256 *and* use sufficient entropy.
2364 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002365 *
2366 * Module: library/ctr_drbg.c
2367 * Caller:
2368 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002369 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002370 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002371 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002374
2375/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002376 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002377 *
2378 * Enable the debug functions.
2379 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002381 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002382 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002383 * library/ssl_tls12_*.c
2384 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002385 *
2386 * This module provides debugging functions.
2387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002389
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002390/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002392 *
2393 * Enable the DES block cipher.
2394 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002395 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002396 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002397 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002398 *
Paul Bakkercff68422013-09-15 20:43:33 +02002399 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002400 *
2401 * \warning DES is considered a weak cipher and its use constitutes a
2402 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002403 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002405
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002406/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002408 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002409 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002410 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002411 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002412 * Caller: library/ssl_tls.c
2413 * library/ssl*_client.c
2414 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002415 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002416 * This module is used by the following key exchanges:
2417 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002418 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002419 * \warning Using DHE constitutes a security risk as it
2420 * is not possible to validate custom DH parameters.
2421 * If possible, it is recommended users should consider
2422 * preferring other methods of key exchange.
2423 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002424 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002427
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002430 *
2431 * Enable the elliptic curve Diffie-Hellman library.
2432 *
2433 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002434 * Caller: library/psa_crypto.c
2435 * library/ssl_tls.c
2436 * library/ssl*_client.c
2437 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002438 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002439 * This module is used by the following key exchanges:
2440 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002441 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002442 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002445
2446/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002448 *
2449 * Enable the elliptic curve DSA library.
2450 *
2451 * Module: library/ecdsa.c
2452 * Caller:
2453 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002454 * This module is used by the following key exchanges:
2455 * ECDHE-ECDSA
2456 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002457 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2458 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2459 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002461#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002462
2463/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002464 * \def MBEDTLS_ECJPAKE_C
2465 *
2466 * Enable the elliptic curve J-PAKE library.
2467 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002468 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2469 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002470 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002471 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002472 * Module: library/ecjpake.c
2473 * Caller:
2474 *
2475 * This module is used by the following key exchanges:
2476 * ECJPAKE
2477 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002478 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002479 *
2480 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2481 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002482 *
2483 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002484 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002485 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2486 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002487 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002488#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002489
2490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002491 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002492 *
2493 * Enable the elliptic curve over GF(p) library.
2494 *
2495 * Module: library/ecp.c
2496 * Caller: library/ecdh.c
2497 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002498 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002499 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002500 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002503
2504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002506 *
2507 * Enable the platform-specific entropy code.
2508 *
2509 * Module: library/entropy.c
2510 * Caller:
2511 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002513 *
2514 * This module provides a generic entropy pool
2515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002516#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002517
2518/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002520 *
2521 * Enable error code to error string conversion.
2522 *
2523 * Module: library/error.c
2524 * Caller:
2525 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002529
2530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002532 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002533 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002534 *
2535 * Module: library/gcm.c
2536 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002537 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2538 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002539 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002540 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2541 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002542 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002544
2545/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002546 * \def MBEDTLS_HKDF_C
2547 *
2548 * Enable the HKDF algorithm (RFC 5869).
2549 *
2550 * Module: library/hkdf.c
2551 * Caller:
2552 *
2553 * Requires: MBEDTLS_MD_C
2554 *
2555 * This module adds support for the Hashed Message Authentication Code
2556 * (HMAC)-based key derivation function (HKDF).
2557 */
2558#define MBEDTLS_HKDF_C
2559
2560/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002561 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002562 *
2563 * Enable the HMAC_DRBG random generator.
2564 *
2565 * Module: library/hmac_drbg.c
2566 * Caller:
2567 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002569 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002570 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002571 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002572#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002573
2574/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002575 * \def MBEDTLS_LMS_C
2576 *
2577 * Enable the LMS stateful-hash asymmetric signature algorithm.
2578 *
2579 * Module: library/lms.c
2580 * Caller:
2581 *
Raef Colesab4f8742022-09-01 12:24:31 +01002582 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002583 *
Raef Colesab4f8742022-09-01 12:24:31 +01002584 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002585 */
2586#define MBEDTLS_LMS_C
2587
2588/**
Raef Colesab4f8742022-09-01 12:24:31 +01002589 * \def MBEDTLS_LMS_PRIVATE
2590 *
2591 * Enable LMS private-key operations and signing code. Functions enabled by this
2592 * option are experimental, and should not be used in production.
2593 *
2594 * Requires: MBEDTLS_LMS_C
2595 *
2596 * Uncomment to enable the LMS signature algorithm and private key operations.
2597 */
Raef Coles5127e852022-10-07 10:35:56 +01002598//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002599
2600/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002601 * \def MBEDTLS_NIST_KW_C
2602 *
2603 * Enable the Key Wrapping mode for 128-bit block ciphers,
2604 * as defined in NIST SP 800-38F. Only KW and KWP modes
2605 * are supported. At the moment, only AES is approved by NIST.
2606 *
2607 * Module: library/nist_kw.c
2608 *
2609 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2610 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002611#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002612
2613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002615 *
2616 * Enable the generic message digest layer.
2617 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002618 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2619 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2620 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002621 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002622 * Caller: library/constant_time.c
2623 * library/ecdsa.c
2624 * library/ecjpake.c
2625 * library/hkdf.c
2626 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002627 * library/pk.c
2628 * library/pkcs5.c
2629 * library/pkcs12.c
2630 * library/psa_crypto_ecp.c
2631 * library/psa_crypto_rsa.c
2632 * library/rsa.c
2633 * library/ssl_cookie.c
2634 * library/ssl_msg.c
2635 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002636 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002637 * library/x509_crt.c
2638 * library/x509write_crt.c
2639 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002640 *
2641 * Uncomment to enable generic message digest wrappers.
2642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002643#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002644
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002647 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002648 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002649 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002650 * Module: library/md5.c
2651 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002652 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002653 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002654 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002655 * This module is required for TLS 1.2 depending on the handshake parameters.
2656 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2657 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002658 *
2659 * \warning MD5 is considered a weak message digest and its use constitutes a
2660 * security risk. If possible, we recommend avoiding dependencies on
2661 * it, and considering stronger message digests instead.
2662 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002663 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002665
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002668 *
2669 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002670 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002671 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002672 *
2673 * Module: library/memory_buffer_alloc.c
2674 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * Requires: MBEDTLS_PLATFORM_C
2676 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002677 *
2678 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002679 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002681
2682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002683 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002684 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002685 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2686 *
Simon Butcherd567a232016-03-09 20:19:21 +00002687 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2688 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002689 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002690 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002691 * \note See also our Knowledge Base article about porting to a new
2692 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002693 * 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 +00002694 *
Andres AG788aa4a2016-09-14 14:32:09 +01002695 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002696 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002697 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002700
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002703 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002704 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002705 *
2706 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002707 * Caller: library/asn1write.c
2708 * library/pkcs5.c
2709 * library/pkparse.c
2710 * library/pkwrite.c
2711 * library/rsa.c
2712 * library/x509.c
2713 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002714 * library/x509_crl.c
2715 * library/x509_crt.c
2716 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002717 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002718 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002719 *
2720 * This modules translates between OIDs and internal values.
2721 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002722#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002723
2724/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002725 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002726 *
2727 * Enable VIA Padlock support on x86.
2728 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002729 * Module: library/padlock.c
2730 * Caller: library/aes.c
2731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002733 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002734 * This modules adds support for the VIA PadLock on x86.
2735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002737
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002740 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002741 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002742 *
2743 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002744 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002745 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002746 * library/x509_crl.c
2747 * library/x509_crt.c
2748 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002749 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002751 *
Paul Bakkercff68422013-09-15 20:43:33 +02002752 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002755
2756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002758 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002759 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002760 *
2761 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002762 * Caller: library/pkwrite.c
2763 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002764 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002765 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002766 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002767 *
2768 * This modules adds support for encoding / writing PEM files.
2769 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002770#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002771
2772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002774 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002775 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002776 *
2777 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002778 * Caller: library/psa_crypto_rsa.c
2779 * library/ssl_tls.c
2780 * library/ssl*_client.c
2781 * library/ssl*_server.c
2782 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002783 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002784 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002785 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002786 * Uncomment to enable generic public key wrappers.
2787 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002789
2790/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002792 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002793 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002794 *
2795 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002796 * Caller: library/x509_crt.c
2797 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002798 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002800 *
2801 * Uncomment to enable generic public key parse functions.
2802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002803#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002804
2805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002806 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002807 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002808 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002809 *
2810 * Module: library/pkwrite.c
2811 * Caller: library/x509write.c
2812 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002814 *
2815 * Uncomment to enable generic public key write functions.
2816 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002818
2819/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002821 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002822 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002823 *
2824 * Module: library/pkcs5.c
2825 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002826 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2827 *
2828 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2829 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002830 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002831 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002832 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002833 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2834 * this module in builds where MBEDTLS_MD_C is disabled.
2835 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002836 * This module adds support for the PKCS#5 functions.
2837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002839
2840/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002841 * \def MBEDTLS_PKCS7_C
2842 *
Dave Rodgmandbcbf442022-12-05 11:15:10 +00002843 * This feature is a work in progress and not ready for production. Testing and
2844 * validation is incomplete, and handling of malformed inputs may not be robust.
2845 * The API may change.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002846 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002847 * Enable PKCS7 core for using PKCS7 formatted signatures.
2848 * RFC Link - https://tools.ietf.org/html/rfc2315
2849 *
2850 * Module: library/pkcs7.c
2851 *
2852 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002853 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2854 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002855 *
2856 * This module is required for the PKCS7 parsing modules.
2857 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002858//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002859
2860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002862 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002863 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002864 * Adds algorithms for parsing PKCS#8 encrypted private keys
2865 *
2866 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002867 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002868 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002869 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2870 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2871 *
2872 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2873 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002874 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002875 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002876 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002877 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2878 * this module in builds where MBEDTLS_MD_C is disabled.
2879 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002880 * This module enables PKCS#12 functions.
2881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002882#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002883
2884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002886 *
2887 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002888 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2891 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002892 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002893 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002894 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002895 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002896 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002897 * Module: library/platform.c
2898 * Caller: Most other .c files
2899 *
2900 * This module enables abstraction of common (libc) functions.
2901 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002902#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002903
2904/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002905 * \def MBEDTLS_POLY1305_C
2906 *
2907 * Enable the Poly1305 MAC algorithm.
2908 *
2909 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002910 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002911 */
2912#define MBEDTLS_POLY1305_C
2913
2914/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002915 * \def MBEDTLS_PSA_CRYPTO_C
2916 *
2917 * Enable the Platform Security Architecture cryptography API.
2918 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002919 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002920 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002921 * Requires: MBEDTLS_CIPHER_C,
2922 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002923 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002924 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002925 *
2926 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002927#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002928
2929/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002930 * \def MBEDTLS_PSA_CRYPTO_SE_C
2931 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002932 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002933 * cryptography API.
2934 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002935 * \deprecated This feature is deprecated. Please switch to the driver
2936 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002937 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002938 * Module: library/psa_crypto_se.c
2939 *
2940 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2941 *
2942 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002943//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002944
2945/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002946 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2947 *
2948 * Enable the Platform Security Architecture persistent key storage.
2949 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002950 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002951 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002952 * Requires: MBEDTLS_PSA_CRYPTO_C,
2953 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2954 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002955 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002956#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002957
2958/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002959 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002960 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002961 * Enable the emulation of the Platform Security Architecture
2962 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002963 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002964 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002965 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002966 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002967 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002968#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002969
2970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002972 *
2973 * Enable the RIPEMD-160 hash algorithm.
2974 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002975 * Module: library/ripemd160.c
2976 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002977 *
2978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002979#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002980
2981/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002982 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002983 *
2984 * Enable the RSA public-key cryptosystem.
2985 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002986 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002987 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002988 * Caller: library/pk.c
2989 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002990 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002991 * library/ssl*_client.c
2992 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002993 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002994 * This module is used by the following key exchanges:
2995 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002996 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002999#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003003 *
3004 * Enable the SHA1 cryptographic hash algorithm.
3005 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003006 * Module: library/sha1.c
3007 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003008 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003009 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003010 * This module is required for TLS 1.2 depending on the handshake parameters,
3011 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003012 *
3013 * \warning SHA-1 is considered a weak message digest and its use constitutes
3014 * a security risk. If possible, we recommend avoiding dependencies
3015 * on it, and considering stronger message digests instead.
3016 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003017 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003019
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003020/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003021 * \def MBEDTLS_SHA224_C
3022 *
3023 * Enable the SHA-224 cryptographic hash algorithm.
3024 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003025 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003026 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003027 *
3028 * Module: library/sha256.c
3029 * Caller: library/md.c
3030 * library/ssl_cookie.c
3031 *
3032 * This module adds support for SHA-224.
3033 */
3034#define MBEDTLS_SHA224_C
3035
3036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003038 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003039 * Enable the SHA-256 cryptographic hash algorithm.
3040 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003041 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003042 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003043 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003044 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003045 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003046 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003047 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003048 * library/ssl*_client.c
3049 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003050 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003051 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003052 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003054#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003055
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003056/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003057 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3058 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003059 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3060 * with the ARMv8 cryptographic extensions if they are available at runtime.
3061 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003062 *
3063 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3064 * for a non-Aarch64 build it will be silently ignored.
3065 *
3066 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3067 * of \c -march=armv8-a+crypto.
3068 *
3069 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3070 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3071 *
3072 * Requires: MBEDTLS_SHA256_C.
3073 *
3074 * Module: library/sha256.c
3075 *
3076 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3077 * and use them if available.
3078 */
3079//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3080
3081/**
3082 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3083 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003084 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3085 * with the ARMv8 cryptographic extensions, which must be available at runtime
3086 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003087 *
3088 * \note This allows builds with a smaller code size than with
3089 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3090 *
3091 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3092 * of \c -march=armv8-a+crypto.
3093 *
3094 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3095 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3096 *
3097 * Requires: MBEDTLS_SHA256_C.
3098 *
3099 * Module: library/sha256.c
3100 *
3101 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3102 * unconditionally.
3103 */
3104//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3105
3106/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003107 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003108 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003109 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003110 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003111 * Requires: MBEDTLS_SHA512_C
3112 *
3113 * Module: library/sha512.c
3114 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003115 * library/psa_crypto_hash.c
3116 * library/ssl_tls.c
3117 * library/ssl*_client.c
3118 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003119 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003120 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003121 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003122#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003123
3124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003125 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003126 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003127 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003128 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003129 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003130 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003131 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003132 * library/ssl_tls.c
3133 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003134 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003135 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003138
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003139/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003140 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3141 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003142 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3143 * with the ARMv8 cryptographic extensions if they are available at runtime.
3144 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003145 *
3146 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3147 * for a non-Aarch64 build it will be silently ignored.
3148 *
3149 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3150 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3151 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3152 * fastest code.
3153 *
3154 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3155 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3156 *
3157 * Requires: MBEDTLS_SHA512_C.
3158 *
3159 * Module: library/sha512.c
3160 *
3161 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3162 * and use them if available.
3163 */
3164//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3165
3166/**
3167 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3168 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003169 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3170 * with the ARMv8 cryptographic extensions, which must be available at runtime
3171 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003172 *
3173 * \note This allows builds with a smaller code size than with
3174 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3175 *
3176 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3177 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3178 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3179 * fastest code.
3180 *
3181 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3182 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3183 *
3184 * Requires: MBEDTLS_SHA512_C.
3185 *
3186 * Module: library/sha512.c
3187 *
3188 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3189 * unconditionally.
3190 */
3191//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3192
3193/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003194 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003195 *
3196 * Enable simple SSL cache implementation.
3197 *
3198 * Module: library/ssl_cache.c
3199 * Caller:
3200 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003203#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003204
3205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003207 *
3208 * Enable basic implementation of DTLS cookies for hello verification.
3209 *
3210 * Module: library/ssl_cookie.c
3211 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003213#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003214
3215/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003216 * \def MBEDTLS_SSL_TICKET_C
3217 *
3218 * Enable an implementation of TLS server-side callbacks for session tickets.
3219 *
3220 * Module: library/ssl_ticket.c
3221 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003222 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003223 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3224 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003225 */
3226#define MBEDTLS_SSL_TICKET_C
3227
3228/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003230 *
3231 * Enable the SSL/TLS client code.
3232 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003233 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003234 * Caller:
3235 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003236 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003237 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003238 * This module is required for SSL/TLS client support.
3239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003241
Paul Bakker9a736322012-11-14 12:39:52 +00003242/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003243 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003244 *
3245 * Enable the SSL/TLS server code.
3246 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003247 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003248 * Caller:
3249 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003251 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003252 * This module is required for SSL/TLS server support.
3253 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003255
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003256/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003258 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003259 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003260 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003261 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003262 * Caller: library/ssl*_client.c
3263 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003264 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003265 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3266 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003268 * This module is required for SSL/TLS.
3269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003271
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003272/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003273 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003274 *
3275 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003276 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003277 * contexts are not shared between threads. If you do intend to use contexts
3278 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003279 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003280 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003281 *
3282 * Module: library/threading.c
3283 *
3284 * This allows different threading implementations (self-implemented or
3285 * provided).
3286 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * You will have to enable either MBEDTLS_THREADING_ALT or
3288 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003289 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003290 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003293
3294/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003296 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003297 * Enable the semi-portable timing interface.
3298 *
Simon Butcherd567a232016-03-09 20:19:21 +00003299 * \note The provided implementation only works on POSIX/Unix (including Linux,
3300 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003301 * module and provide your own implementations of the callbacks needed by
3302 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3303 * your own implementation of the whole module by setting
3304 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003305 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003306 * \note The timing module will include time.h on suitable platforms
3307 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3308 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3309 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003310 * \note See also our Knowledge Base article about porting to a new
3311 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003312 * 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 +00003313 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003317
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003320 *
3321 * Enable run-time version information.
3322 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003323 * Module: library/version.c
3324 *
3325 * This module provides run-time version information.
3326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003328
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003331 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003332 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003333 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003334 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003335 * Caller: library/x509_crl.c
3336 * library/x509_crt.c
3337 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003338 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003339 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003340 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3341 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003342 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3343 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003344 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003345 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003348
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003349/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003351 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003352 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003353 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003354 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003355 * Caller: library/ssl_tls.c
3356 * library/ssl*_client.c
3357 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003360 *
3361 * This module is required for X.509 certificate parsing.
3362 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003364
3365/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003367 *
3368 * Enable X.509 CRL parsing.
3369 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003370 * Module: library/x509_crl.c
3371 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003374 *
3375 * This module is required for X.509 CRL parsing.
3376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003377#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003378
3379/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003381 *
3382 * Enable X.509 Certificate Signing Request (CSR) parsing.
3383 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003384 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003385 * Caller: library/x509_crt_write.c
3386 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
3389 * This module is used for reading X.509 certificate request.
3390 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003392
3393/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003395 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003396 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003397 *
3398 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003399 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003400 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003401 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3402 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003403 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3404 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003405 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003406 * This module is the basis for creating X.509 certificates and CSRs.
3407 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003409
3410/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003411 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003412 *
3413 * Enable creating X.509 certificates.
3414 *
3415 * Module: library/x509_crt_write.c
3416 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003418 *
3419 * This module is required for X.509 certificate creation.
3420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003421#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003422
3423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003425 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003426 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003427 *
3428 * Module: library/x509_csr_write.c
3429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003431 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003432 * This module is required for X.509 certificate request writing.
3433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003435
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003436/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003437
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003438/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003439 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003440 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003441 * This section contains Mbed TLS build settings that are not associated
3442 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003443 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003444 * \{
3445 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003446
Gilles Peskinea02c1242022-03-16 17:03:19 +01003447/**
3448 * \def MBEDTLS_CONFIG_FILE
3449 *
3450 * If defined, this is a header which will be included instead of
3451 * `"mbedtls/mbedtls_config.h"`.
3452 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003453 * Unlike other configuration options, this one must be defined on the
3454 * compiler command line: a definition in `mbedtls_config.h` would have
3455 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003456 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003457 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003458 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003459 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003460 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003461 * The value of this symbol is typically a path in double quotes, either
3462 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003463 */
3464//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3465
3466/**
3467 * \def MBEDTLS_USER_CONFIG_FILE
3468 *
3469 * If defined, this is a header which will be included after
3470 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003471 * This allows you to modify the default configuration, including the ability
3472 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003473 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003474 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003475 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003476 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003477 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003478 * The value of this symbol is typically a path in double quotes, either
3479 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003480 */
3481//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3482
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003483/**
3484 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3485 *
3486 * If defined, this is a header which will be included instead of
3487 * `"psa/crypto_config.h"`.
3488 * This header file specifies which cryptographic mechanisms are available
3489 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3490 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3491 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003492 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003493 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003494 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003495 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003496 * The value of this symbol is typically a path in double quotes, either
3497 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003498 */
3499//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3500
3501/**
3502 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3503 *
3504 * If defined, this is a header which will be included after
3505 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003506 * This allows you to modify the default configuration, including the ability
3507 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003508 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003509 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003510 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003511 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003512 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003513 * The value of this symbol is typically a path in double quotes, either
3514 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003515 */
3516//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3517
Gilles Peskineba4162a2022-04-11 17:04:38 +02003518/** \} name SECTION: General configuration options */
3519
3520/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003521 * \name SECTION: Module configuration options
3522 *
3523 * This section allows for the setting of module specific sizes and
3524 * configuration options. The default values are already present in the
3525 * relevant header files and should suffice for the regular use cases.
3526 *
3527 * Our advice is to enable options and change their values here
3528 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003529 * \{
3530 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003531/* The Doxygen documentation here is used when a user comments out a
3532 * setting and runs doxygen themselves. On the other hand, when we typeset
3533 * the full documentation including disabled settings, the documentation
3534 * in specific modules' header files is used if present. When editing this
3535 * file, make sure that each option is documented in exactly one place,
3536 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3537 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003538
Paul Bakker088c5c52014-04-25 11:11:10 +02003539/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003540//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003541//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003542
Paul Bakker088c5c52014-04-25 11:11:10 +02003543/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003544//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3545//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3546//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3547//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3548//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003549
Paul Bakker088c5c52014-04-25 11:11:10 +02003550/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003551//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3552//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3553//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3554//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003555
Paul Bakker088c5c52014-04-25 11:11:10 +02003556/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003557//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003558//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003559
Paul Bakker088c5c52014-04-25 11:11:10 +02003560/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3562//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003563//#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 +01003564
Paul Bakker088c5c52014-04-25 11:11:10 +02003565/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003567
Paul Bakker088c5c52014-04-25 11:11:10 +02003568/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569//#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 +02003570//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003572//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003574//#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 +02003575//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3576//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003577/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003579//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3580//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003581//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3582//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3583//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003584
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3586/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003587//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003588//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3589//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003590//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003591//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3592//#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 +02003593//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3594//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003595/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003597//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003598//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3599//#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 +02003600
Gilles Peskine3f106f72021-09-23 17:42:39 +02003601/** \def MBEDTLS_CHECK_RETURN
3602 *
3603 * This macro is used at the beginning of the declaration of a function
3604 * to indicate that its return value should be checked. It should
3605 * instruct the compiler to emit a warning or an error if the function
3606 * is called without checking its return value.
3607 *
3608 * There is a default implementation for popular compilers in platform_util.h.
3609 * You can override the default implementation by defining your own here.
3610 *
3611 * If the implementation here is empty, this will effectively disable the
3612 * checking of functions' return values.
3613 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003614//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003615
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003616/** \def MBEDTLS_IGNORE_RETURN
3617 *
3618 * This macro requires one argument, which should be a C function call.
3619 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3620 * warning is suppressed.
3621 */
3622//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3623
Gilles Peskineed038902020-11-13 21:33:21 +01003624/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003625/**
Gilles Peskineed038902020-11-13 21:33:21 +01003626 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3627 * PSA crypto subsystem.
3628 *
3629 * If this option is unset:
3630 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003631 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003632 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3633 * on unspecified heuristics.
3634 */
3635//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3636
Steven Cooreman863470a2021-02-15 14:03:19 +01003637/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003638 * Restrict the PSA library to supporting a maximum amount of simultaneously
3639 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3640 * volatile key, or a persistent key which is loaded temporarily by the
3641 * library as part of a crypto operation in flight.
3642 *
3643 * If this option is unset, the library will fall back to a default value of
3644 * 32 keys.
3645 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003646//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003647
Paul Bakker088c5c52014-04-25 11:11:10 +02003648/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3650//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003651
Paul Bakker088c5c52014-04-25 11:11:10 +02003652/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003653
Angus Grattond8213d02016-05-25 20:56:48 +10003654/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3655 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003656 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003657 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003658 * This determines the size of the incoming TLS I/O buffer in such a way
3659 * that it is capable of holding the specified amount of plaintext data,
3660 * regardless of the protection mechanism used.
3661 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003662 * \note When using a value less than the default of 16KB on the client, it is
3663 * recommended to use the Maximum Fragment Length (MFL) extension to
3664 * inform the server about this limitation. On the server, there
3665 * is no supported, standardized way of informing the client about
3666 * restriction on the maximum size of incoming messages, and unless
3667 * the limitation has been communicated by other means, it is recommended
3668 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3669 * while keeping the default value of 16KB for the incoming buffer.
3670 *
David Horstmann95d516f2021-05-04 18:36:56 +01003671 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003672 */
3673//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3674
Gilles Peskined3d02902020-03-04 21:35:27 +01003675/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3676 *
3677 * The maximum length of CIDs used for incoming DTLS messages.
3678 *
3679 */
3680//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3681
3682/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3683 *
3684 * The maximum length of CIDs used for outgoing DTLS messages.
3685 *
3686 */
3687//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3688
TRodziewicze8dd7092021-05-12 14:19:11 +02003689/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003690 *
3691 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003692 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003693 *
3694 * The padding will always be chosen so that the length of the
3695 * padded plaintext is a multiple of the value of this option.
3696 *
3697 * Note: A value of \c 1 means that no padding will be used
3698 * for outgoing records.
3699 *
3700 * Note: On systems lacking division instructions,
3701 * a power of two should be preferred.
3702 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003703//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003704
Angus Grattond8213d02016-05-25 20:56:48 +10003705/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3706 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003707 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003708 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003709 * This determines the size of the outgoing TLS I/O buffer in such a way
3710 * that it is capable of holding the specified amount of plaintext data,
3711 * regardless of the protection mechanism used.
3712 *
Angus Grattond8213d02016-05-25 20:56:48 +10003713 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3714 * the default inward 16384 byte buffer to conform to the TLS specification.
3715 *
3716 * The minimum required outward buffer size is determined by the handshake
3717 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3718 * The specific size requirement depends on the configured ciphers and any
3719 * certificate data which is sent during the handshake.
3720 *
David Horstmann95d516f2021-05-04 18:36:56 +01003721 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003722 */
3723//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3724
Hanno Beckere0b150f2018-08-21 15:51:03 +01003725/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3726 *
3727 * Maximum number of heap-allocated bytes for the purpose of
3728 * DTLS handshake message reassembly and future message buffering.
3729 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003730 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003731 * to account for a reassembled handshake message of maximum size,
3732 * together with its reassembly bitmap.
3733 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003734 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003735 * should be sufficient for all practical situations as it allows
3736 * to reassembly a large handshake message (such as a certificate)
3737 * while buffering multiple smaller handshake messages.
3738 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003739 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003740//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003741
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003742//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3743//#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 +02003744
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003745/**
3746 * Complete list of ciphersuites to use, in order of preference.
3747 *
3748 * \warning No dependency checking is done on that field! This option can only
3749 * be used to restrict the set of available ciphersuites. It is your
3750 * responsibility to make sure the needed modules are active.
3751 *
3752 * Use this to save a few hundred bytes of ROM (default ordering of all
3753 * available ciphersuites) and a few to a few hundred bytes of RAM.
3754 *
3755 * The value below is only an example, not the default.
3756 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003757//#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 +02003758
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003759/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003760//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003761//#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 +01003762
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003763/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003764 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003765 * mbedtls_platform_zeroize(). This replaces the default implementation in
3766 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003767 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003768 * mbedtls_platform_zeroize() is a widely used function across the library to
3769 * zero a block of memory. The implementation is expected to be secure in the
3770 * sense that it has been written to prevent the compiler from removing calls
3771 * to mbedtls_platform_zeroize() as part of redundant code elimination
3772 * optimizations. However, it is difficult to guarantee that calls to
3773 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3774 * versions of the C language standards do not provide a secure implementation
3775 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3776 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003777 * example by using directives specific to their compiler, features from newer
3778 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003779 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003780 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003781//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003782
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003783/**
3784 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003785 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003786 * platform_util.c.
3787 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003788 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003789 * library will try to use safer implementations of this function, such as
3790 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003791 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003792 * using the standard gmtime(). In this case, calls from the library to
3793 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003794 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003795 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003796 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3797 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3798 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003799 */
Hanno Becker6a739782018-09-05 15:06:19 +01003800//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003801
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003802/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003803 * Enable the verified implementations of ECDH primitives from Project Everest
3804 * (currently only Curve25519). This feature changes the layout of ECDH
3805 * contexts and therefore is a compatibility break for applications that access
3806 * fields of a mbedtls_ecdh_context structure directly. See also
3807 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003808 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003809//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003810
Gilles Peskine611179c2022-04-13 23:04:48 +02003811/** \} name SECTION: Module configuration options */