blob: 0e45bcac1ede81a62e0ee517225bb100193dac75 [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é-Gonnardc9e16a92017-08-15 14:30:59 +0200693 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200694 *
Ron Eldor19779c42018-11-05 16:58:13 +0200695 * \note This option only works with the default software implementation of
696 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100697 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100698 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200699//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100700
701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100703 *
704 * Enable deterministic ECDSA (RFC 6979).
705 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
706 * may result in a compromise of the long-term signing key. This is avoided by
707 * the deterministic variant.
708 *
John Durkop36a82e52020-10-26 09:39:05 -0700709 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100710 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100711 * Comment this macro to disable deterministic ECDSA.
712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100714
715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200717 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200718 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200719 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200720 * This enables the following ciphersuites (if other requisites are
721 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
723 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
724 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
725 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
726 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
727 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
728 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
729 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
730 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
731 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200734
735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200737 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200738 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200739 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200741 *
742 * This enables the following ciphersuites (if other requisites are
743 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
745 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
746 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
747 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
748 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
749 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
750 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
751 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
752 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
753 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100754 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100755 * \warning Using DHE constitutes a security risk as it
756 * is not possible to validate custom DH parameters.
757 * If possible, it is recommended users should consider
758 * preferring other methods of key exchange.
759 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100760 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200766 *
767 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200770 *
771 * This enables the following ciphersuites (if other requisites are
772 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
774 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
775 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
776 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
777 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
778 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200781
782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200785 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
788 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
790 * This enables the following ciphersuites (if other requisites are
791 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
793 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
794 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
795 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
796 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
797 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
798 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
799 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
800 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
801 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804
805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200808 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
811 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
813 * This enables the following ciphersuites (if other requisites are
814 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
816 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
817 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
818 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
819 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
820 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
821 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
822 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
823 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
824 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
825 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
826 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829
830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200833 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
836 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
841 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
842 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
843 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
844 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
845 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
846 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
847 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
848 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
849 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
850 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
851 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100852 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100853 * \warning Using DHE constitutes a security risk as it
854 * is not possible to validate custom DH parameters.
855 * If possible, it is recommended users should consider
856 * preferring other methods of key exchange.
857 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100858 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861
862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200865 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
868 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
870 * This enables the following ciphersuites (if other requisites are
871 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
873 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
874 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
875 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
876 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
877 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
878 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
879 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
880 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
881 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884
885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200888 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200891 *
892 * This enables the following ciphersuites (if other requisites are
893 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
895 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
896 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
897 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
898 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
900 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
901 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
902 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909 *
910 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
911 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200912 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
918 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
919 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
921 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
922 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
924 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
925 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100928
929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100931 *
932 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
933 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200934 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935 *
936 * This enables the following ciphersuites (if other requisites are
937 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
939 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
940 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
942 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
943 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
944 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
945 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
946 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
947 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950
951/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200952 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
953 *
954 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
955 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200956 * \warning This is currently experimental. EC J-PAKE support is based on the
957 * Thread v1.0.0 specification; incompatible changes to the specification
958 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200959 *
960 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200961 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200962 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
963 *
964 * This enables the following ciphersuites (if other requisites are
965 * enabled as well):
966 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
967 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200968//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200969
970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100972 *
973 * Enhance support for reading EC keys using variants of SEC1 not allowed by
974 * RFC 5915 and RFC 5480.
975 *
976 * Currently this means parsing the SpecifiedECDomain choice of EC
977 * parameters (only known groups are supported, not arbitrary domains, to
978 * avoid validation issues).
979 *
980 * Disable if you only need to support RFC 5915 + 5480 key formats.
981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100983
984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * Enable a dummy error function to make use of mbedtls_strerror() in
988 * third party libraries easier when MBEDTLS_ERROR_C is disabled
989 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
992 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993 *
994 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001001 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001002 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001010 *
1011 * Enable functions that use the filesystem.
1012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001014
1015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001017 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001018 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001019 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001020 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001021 * application.
1022 *
1023 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001026
1027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001029 *
1030 * Do not use built-in platform entropy functions.
1031 * This is useful if your platform does not support
1032 * standards like the /dev/urandom or Windows CryptoAPI.
1033 *
1034 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001037
1038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001040 *
1041 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1042 * default SHA-512 based one (if both are available).
1043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001045 *
1046 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1047 * if you have performance concerns.
1048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * This option is only useful if both MBEDTLS_SHA256_C and
1050 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001053
1054/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001055 * \def MBEDTLS_ENTROPY_NV_SEED
1056 *
1057 * Enable the non-volatile (NV) seed file-based entropy source.
1058 * (Also enables the NV seed read/write functions in the platform layer)
1059 *
1060 * This is crucial (if not required) on systems that do not have a
1061 * cryptographic entropy source (in hardware or kernel) available.
1062 *
1063 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1064 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001065 * \note The read/write functions that are used by the entropy source are
1066 * determined in the platform layer, and can be modified at runtime and/or
1067 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1068 *
1069 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001070 * with regular fopen(), please make sure you make a seedfile with the
1071 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1072 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001073 * and written to or you will get an entropy source error! The default
1074 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1075 * bytes from the file.
1076 *
1077 * \note The entropy collector will write to the seed file before entropy is
1078 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001079 */
1080//#define MBEDTLS_ENTROPY_NV_SEED
1081
Ronald Cron71016a92020-08-28 19:01:50 +02001082/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001083 *
Ronald Cron71016a92020-08-28 19:01:50 +02001084 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001085 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001086 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1087 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088 *
1089 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001090 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001091 */
Ronald Cron71016a92020-08-28 19:01:50 +02001092//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001093
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001096 *
1097 * Enable debugging of buffer allocator memory issues. Automatically prints
1098 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1099 * function for 'debug output' of allocated memory.
1100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001102 *
1103 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001109 *
1110 * Include backtrace information with each allocated block.
1111 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001113 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001114 *
1115 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001118
1119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001121 *
1122 * Support external private RSA keys (eg from a HSM) in the PK layer.
1123 *
1124 * Comment this macro to disable support for external private RSA keys.
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001130 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001131 * Enable support for PKCS#1 v1.5 encoding.
1132 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001133 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001134 *
Paul Bakker48377d92013-08-30 12:06:24 +02001135 * This enables support for PKCS#1 v1.5 operations.
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001141 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001142 * Enable support for PKCS#1 v2.1 encoding.
1143 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001144 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1145 *
1146 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1147 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001148 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001149 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001150 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001151 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1152 * this module in builds where MBEDTLS_MD_C is disabled.
1153 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001154 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001157
Steven Cooreman6801f082021-02-19 17:21:22 +01001158/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1159 *
1160 * Enable support for platform built-in keys. If you enable this feature,
1161 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1162 * See the documentation of that function for more information.
1163 *
1164 * Built-in keys are typically derived from a hardware unique key or
1165 * stored in a secure element.
1166 *
1167 * Requires: MBEDTLS_PSA_CRYPTO_C.
1168 *
1169 * \warning This interface is experimental and may change or be removed
1170 * without notice.
1171 */
1172//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1173
Ronald Cron3768ac12021-01-26 16:58:00 +01001174/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1175 *
1176 * Enable support for PSA crypto client.
1177 *
1178 * \note This option allows to include the code necessary for a PSA
1179 * crypto client when the PSA crypto implementation is not included in
1180 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1181 * code to set and get PSA key attributes.
1182 * The development of PSA drivers partially relying on the library to
1183 * fulfill the hardware gaps is another possible usage of this option.
1184 *
1185 * \warning This interface is experimental and may change or be removed
1186 * without notice.
1187 */
1188//#define MBEDTLS_PSA_CRYPTO_CLIENT
1189
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001190/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1191 *
1192 * Enable support for the experimental PSA crypto driver interface.
1193 *
John Durkop185764f2020-10-12 21:32:12 -07001194 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001195 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001196 * \warning This interface is experimental. We intend to maintain backward
1197 * compatibility with application code that relies on drivers,
1198 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001199 */
1200//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1201
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001202/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1203 *
1204 * Make the PSA Crypto module use an external random generator provided
1205 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1206 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001207 * \note This random generator must deliver random numbers with cryptographic
1208 * quality and high performance. It must supply unpredictable numbers
1209 * with a uniform distribution. The implementation of this function
1210 * is responsible for ensuring that the random generator is seeded
1211 * with sufficient entropy. If you have a hardware TRNG which is slow
1212 * or delivers non-uniform output, declare it as an entropy source
1213 * with mbedtls_entropy_add_source() instead of enabling this option.
1214 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001215 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001216 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1217 * and define a function called mbedtls_psa_external_get_random()
1218 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001219 * ```
1220 * psa_status_t mbedtls_psa_external_get_random(
1221 * mbedtls_psa_external_random_context_t *context,
1222 * uint8_t *output, size_t output_size, size_t *output_length);
1223 * );
1224 * ```
1225 * The \c context value is initialized to 0 before the first call.
1226 * The function must fill the \c output buffer with \p output_size bytes
1227 * of random data and set \c *output_length to \p output_size.
1228 *
1229 * Requires: MBEDTLS_PSA_CRYPTO_C
1230 *
1231 * \warning If you enable this option, code that uses the PSA cryptography
1232 * interface will not use any of the entropy sources set up for
1233 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1234 * enables.
1235 *
1236 * \note This option is experimental and may be removed without notice.
1237 */
1238//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1239
Paul Bakker9dcc3222011-03-08 14:16:06 +00001240/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001241 * \def MBEDTLS_PSA_CRYPTO_SPM
1242 *
1243 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1244 * Partition Manager) integration which separates the code into two parts: a
1245 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1246 * Environment).
1247 *
1248 * Module: library/psa_crypto.c
1249 * Requires: MBEDTLS_PSA_CRYPTO_C
1250 *
1251 */
1252//#define MBEDTLS_PSA_CRYPTO_SPM
1253
1254/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001255 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001256 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001257 * Enable support for entropy injection at first boot. This feature is
1258 * required on systems that do not have a built-in entropy source (TRNG).
1259 * This feature is currently not supported on systems that have a built-in
1260 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001261 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001262 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001263 *
1264 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001265//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001266
1267/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001269 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001270 * Do not use the Chinese Remainder Theorem
1271 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001272 *
1273 * Uncomment this macro to disable the use of CRT in RSA.
1274 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001275 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001277
1278/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001279 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001280 *
1281 * Enable the checkup functions (*_self_test).
1282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001284
1285/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001286 * \def MBEDTLS_SHA256_SMALLER
1287 *
1288 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1289 * lower performance.
1290 *
Adam Wolf039080f2019-09-10 09:53:08 -05001291 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001292 * performance and size. This version optimizes more aggressively for size at
1293 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1294 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1295 * 30%.
1296 *
1297 * Uncomment to enable the smaller implementation of SHA256.
1298 */
1299//#define MBEDTLS_SHA256_SMALLER
1300
1301/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001302 * \def MBEDTLS_SHA512_SMALLER
1303 *
1304 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1305 * lower performance.
1306 *
1307 * Uncomment to enable the smaller implementation of SHA512.
1308 */
1309//#define MBEDTLS_SHA512_SMALLER
1310
1311/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001313 *
1314 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001315 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001316 * with other servers, only debugging of failures is harder.
1317 *
1318 * The advantage of not sending alert messages, is that no information is given
1319 * about reasons for failures thus preventing adversaries of gaining intel.
1320 *
1321 * Enable sending of all alert messages
1322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001324
1325/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001326 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1327 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001328 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001329 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001330 * in the underlying transport. The CID functionality is described
1331 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001332 *
1333 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001334 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1335 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1336 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001337 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001338 * The maximum lengths of outgoing and incoming CIDs can be configured
1339 * through the options
1340 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1341 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1342 *
1343 * Requires: MBEDTLS_SSL_PROTO_DTLS
1344 *
1345 * Uncomment to enable the Connection ID extension.
1346 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001347#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1348
1349
1350/**
1351 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1352 *
1353 * Defines whether RFC 9146 (default) or the legacy version
1354 * (version draft-ietf-tls-dtls-connection-id-05,
1355 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1356 * is used.
1357 *
1358 * Set the value to 0 for the standard version, and
1359 * 1 for the legacy draft version.
1360 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001361 * \deprecated Support for the legacy version of the DTLS
1362 * Connection ID feature is deprecated. Please
1363 * switch to the standardized version defined
1364 * in RFC 9146 enabled by utilizing
1365 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1366 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1367 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001368 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1369 */
1370#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001371
1372/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001373 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1374 *
1375 * Enable asynchronous external private key operations in SSL. This allows
1376 * you to configure an SSL connection to call an external cryptographic
1377 * module to perform private key operations instead of performing the
1378 * operation inside the library.
1379 *
1380 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001381//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001382
1383/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001384 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1385 *
1386 * Enable serialization of the TLS context structures, through use of the
1387 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1388 *
1389 * This pair of functions allows one side of a connection to serialize the
1390 * context associated with the connection, then free or re-use that context
1391 * while the serialized state is persisted elsewhere, and finally deserialize
1392 * that state to a live context for resuming read/write operations on the
1393 * connection. From a protocol perspective, the state of the connection is
1394 * unaffected, in particular this is entirely transparent to the peer.
1395 *
1396 * Note: this is distinct from TLS session resumption, which is part of the
1397 * protocol and fully visible by the peer. TLS session resumption enables
1398 * establishing new connections associated to a saved session with shorter,
1399 * lighter handshakes, while context serialization is a local optimization in
1400 * handling a single, potentially long-lived connection.
1401 *
1402 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1403 * saved after the handshake to allow for more efficient serialization, so if
1404 * you don't need this feature you'll save RAM by disabling it.
1405 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001406 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1407 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001408 * Comment to disable the context serialization APIs.
1409 */
1410#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1411
1412/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001413 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001414 *
1415 * Enable the debug messages in SSL module for all issues.
1416 * Debug messages have been disabled in some places to prevent timing
1417 * attacks due to (unbalanced) debugging function calls.
1418 *
1419 * If you need all error reporting you should enable this during debugging,
1420 * but remove this for production servers that should log as well.
1421 *
1422 * Uncomment this macro to report all debug messages on errors introducing
1423 * a timing side-channel.
1424 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001429 *
1430 * Enable support for Encrypt-then-MAC, RFC 7366.
1431 *
1432 * This allows peers that both support it to use a more robust protection for
1433 * ciphersuites using CBC, providing deep resistance against timing attacks
1434 * on the padding or underlying cipher.
1435 *
1436 * This only affects CBC ciphersuites, and is useless if none is defined.
1437 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001438 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001439 *
1440 * Comment this macro to disable support for Encrypt-then-MAC
1441 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001442#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001443
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001445 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001446 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1447 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001448 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001449 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001450 * attacks, but it is recommended to always use it (even if you disable
1451 * renegotiation), since it actually fixes a more fundamental issue in the
1452 * original SSL/TLS design, and has implications beyond Triple Handshake.
1453 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001454 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001455 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001456 * Comment this macro to disable support for Extended Master Secret.
1457 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001459
Paul Bakkerd66f0702013-01-31 16:57:45 +01001460/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001461 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1462 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001463 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001464 * giving access to the peer's certificate after completion of the handshake.
1465 *
1466 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1467 * recommended to disable this option for reduced RAM usage.
1468 *
1469 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1470 * defined, but always returns \c NULL.
1471 *
1472 * \note This option has no influence on the protection against the
1473 * triple handshake attack. Even if it is disabled, Mbed TLS will
1474 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001475 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001476 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001477 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1478 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001479 * Comment this macro to disable storing the peer's certificate
1480 * after the handshake.
1481 */
1482#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1483
1484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001485 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001486 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001487 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001488 *
1489 * The two main uses of renegotiation are (1) refresh keys on long-lived
1490 * connections and (2) client authentication after the initial handshake.
1491 * If you don't need renegotiation, it's probably better to disable it, since
1492 * it has been associated with security issues in the past and is easy to
1493 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001494 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001495 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001496 *
1497 * \note Even if this option is disabled, both client and server are aware
1498 * of the Renegotiation Indication Extension (RFC 5746) used to
1499 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1500 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1501 * configuration of this extension).
1502 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001505
1506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001508 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001509 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001510 *
1511 * Comment this macro to disable support for the max_fragment_length extension
1512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001514
1515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001517 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001518 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001519 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001520 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1521 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1522 * With MBEDTLS_USE_PSA_CRYPTO:
1523 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1524 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001525 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001526 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1527 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001528 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001529 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001531#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001532
1533/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001534 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001535 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001536 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001537 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001538 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1539 * pre-shared keys are not supported.
1540 * See docs/architecture/tls13-support.md for a description of the TLS
1541 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001542 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001543 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001544 * Requires: MBEDTLS_PSA_CRYPTO_C
1545 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001546 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1547 * for most operations, if you want it to only use PSA for all crypto
1548 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1549 * operations, and functions that are common with TLS 1.2 (record protection,
1550 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001551 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001552 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001553 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001554//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001555
1556/**
Ronald Cronab65c522021-11-24 10:47:20 +01001557 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1558 *
1559 * Enable TLS 1.3 middlebox compatibility mode.
1560 *
1561 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1562 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1563 * expecting TLS 1.2 traffic.
1564 *
1565 * Turning on the compatibility mode comes at the cost of a few added bytes
1566 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1567 * that don't use it. Therefore, unless transmission bandwidth is critical and
1568 * you know that middlebox compatibility issues won't occur, it is therefore
1569 * recommended to set this option.
1570 *
1571 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001572 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1573 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001574 *
1575 */
1576//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1577
1578/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001579 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1580 *
1581 * Enable TLS 1.3 PSK key exchange mode.
1582 *
1583 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1584 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1585 * effect on the build.
1586 *
1587 */
1588#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1589
1590/**
1591 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1592 *
1593 * Enable TLS 1.3 ephemeral key exchange mode.
1594 *
1595 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1596 * MBEDTLS_PKCS1_V21
1597 *
1598 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1599 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1600 * effect on the build.
1601 *
1602 */
1603#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1604
1605/**
1606 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1607 *
1608 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1609 *
1610 * Requires: MBEDTLS_ECDH_C
1611 *
1612 * Comment to disable support for the PSK ephemeral key exchange mode in
1613 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1614 * have any effect on the build.
1615 *
1616 */
1617#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1618
1619/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001620 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001621 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001622 * Maximum time difference in milliseconds tolerated between the age of a
1623 * ticket from the server and client point of view.
1624 * From the client point of view, the age of a ticket is the time difference
1625 * between the time when the client proposes to the server to use the ticket
1626 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1627 * the time the client received the ticket from the server.
1628 * From the server point of view, the age of a ticket is the time difference
1629 * between the time when the server receives a proposition from the client
1630 * to use the ticket and the time when the ticket was created by the server.
1631 * The server age is expected to be always greater than the client one and
1632 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1633 * maximum difference tolerated for the server to accept the ticket.
1634 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001635 *
1636 */
1637#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1638
1639/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001640 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1641 *
1642 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1643 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001644 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001645 */
Jerry Yu9750f812022-07-20 11:04:50 +08001646#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001647
1648/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001649 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1650 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001651 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1652 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1653 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001654 *
1655 */
1656#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1657
1658/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001659* \def MBEDTLS_SSL_EARLY_DATA
1660*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001661* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001662*
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001663* Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1664* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1665* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001666*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001667* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001668* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001669*
1670* This feature is experimental, not completed and thus not ready for
1671* production.
1672*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001673*/
Ronald Cronc2e110f2022-11-22 09:01:46 +01001674//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001675
1676/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001677 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001678 *
1679 * Enable support for DTLS (all available versions).
1680 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001681 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001682 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001683 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001684 *
1685 * Comment this macro to disable support for DTLS
1686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001688
1689/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001691 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001692 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001693 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001694 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001697
1698/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001700 *
1701 * Enable support for the anti-replay mechanism in DTLS.
1702 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703 * Requires: MBEDTLS_SSL_TLS_C
1704 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001705 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001706 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001707 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001708 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001709 * Comment this to disable anti-replay in DTLS.
1710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001712
1713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001715 *
1716 * Enable support for HelloVerifyRequest on DTLS servers.
1717 *
1718 * This feature is highly recommended to prevent DTLS servers being used as
1719 * amplifiers in DoS attacks against other hosts. It should always be enabled
1720 * unless you know for sure amplification cannot be a problem in the
1721 * environment in which your server operates.
1722 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001723 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001724 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001725 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001726 *
1727 * Comment this to disable support for HelloVerifyRequest.
1728 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001730
1731/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001732 * \def MBEDTLS_SSL_DTLS_SRTP
1733 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001734 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001735 * through the use_srtp extension.
1736 *
1737 * \note This feature provides the minimum functionality required
1738 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1739 * the associated SRTP packet protection key material.
1740 * In particular, the SRTP packet protection itself, as well as the
1741 * demultiplexing of RTP and DTLS packets at the datagram layer
1742 * (see Section 5 of RFC 5764), are not handled by this feature.
1743 * Instead, after successful completion of a handshake negotiating
1744 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001745 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001746 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1747 * (this is implemented in the SSL example programs).
1748 * The resulting key should then be passed to an SRTP stack.
1749 *
1750 * Setting this option enables the runtime API
1751 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1752 * through which the supported DTLS-SRTP protection
1753 * profiles can be configured. You must call this API at
1754 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001755 *
1756 * Requires: MBEDTLS_SSL_PROTO_DTLS
1757 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001758 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001759 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001760//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001761
1762/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001763 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1764 *
1765 * Enable server-side support for clients that reconnect from the same port.
1766 *
1767 * Some clients unexpectedly close the connection and try to reconnect using the
1768 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001769 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001770 * flag enables that support.
1771 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001772 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001773 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001774 * Comment this to disable support for clients reusing the source port.
1775 */
1776#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1777
1778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001779 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001780 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001781 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001782 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001783 * session store remains the responsibility of the application, though).
1784 * Server-side, you also need to provide callbacks for writing and parsing
1785 * tickets, including authenticated encryption and key management. Example
1786 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001787 *
1788 * Comment this macro to disable support for SSL session tickets
1789 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001790#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001791
1792/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001794 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001795 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001796 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001798 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001799 * Comment this macro to disable support for server name indication in SSL
1800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001802
1803/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001804 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1805 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001806 * When this option is enabled, the SSL buffer will be resized automatically
1807 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001808 *
1809 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001810 */
1811//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1812
1813/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001814 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1815 *
1816 * Enable testing of the constant-flow nature of some sensitive functions with
1817 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001818 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001819 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001820 * This setting requires compiling with clang -fsanitize=memory. The test
1821 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001822 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001823 * \warning This macro is only used for extended testing; it is not considered
1824 * part of the library's API, so it may change or disappear at any time.
1825 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001826 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001827 */
1828//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1829
1830/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001831 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1832 *
1833 * Enable testing of the constant-flow nature of some sensitive functions with
1834 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001835 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001836 *
1837 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001838 * testing if the tests suites are run with valgrind's memcheck. This can be
1839 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1840 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001841 *
1842 * \warning This macro is only used for extended testing; it is not considered
1843 * part of the library's API, so it may change or disappear at any time.
1844 *
1845 * Uncomment to enable testing of the constant-flow nature of selected code.
1846 */
1847//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1848
1849/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001850 * \def MBEDTLS_TEST_HOOKS
1851 *
1852 * Enable features for invasive testing such as introspection functions and
1853 * hooks for fault injection. This enables additional unit tests.
1854 *
1855 * Merely enabling this feature should not change the behavior of the product.
1856 * It only adds new code, and new branching points where the default behavior
1857 * is the same as when this feature is disabled.
1858 * However, this feature increases the attack surface: there is an added
1859 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1860 * Therefore this feature must never be enabled in production.
1861 *
1862 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1863 * information.
1864 *
1865 * Uncomment to enable invasive tests.
1866 */
1867//#define MBEDTLS_TEST_HOOKS
1868
1869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001871 *
1872 * Provide your own alternate threading implementation.
1873 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001875 *
1876 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001877 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001878//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001879
1880/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001881 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001882 *
1883 * Enable the pthread wrapper layer for the threading layer.
1884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001886 *
1887 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001889//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001890
1891/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001892 * \def MBEDTLS_USE_PSA_CRYPTO
1893 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001894 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1895 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001896 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001897 * \note Development of this option is currently in progress, and parts of Mbed
1898 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001899 * will still continue to work as usual, so enabling this option should not
1900 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001901 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001902 * \note See docs/use-psa-crypto.md for a complete description of what this
1903 * option currently does, and of parts that are not affected by it so far.
1904 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001905 * \warning If you enable this option, you need to call `psa_crypto_init()`
1906 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001907 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001908 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001909 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001910 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001911 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001912 */
1913//#define MBEDTLS_USE_PSA_CRYPTO
1914
1915/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001916 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1917 *
John Durkop185764f2020-10-12 21:32:12 -07001918 * This setting allows support for cryptographic mechanisms through the PSA
1919 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001920 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001921 * When this option is disabled, the PSA API exposes the cryptographic
1922 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1923 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001924 *
1925 * When this option is enabled, the PSA API exposes the cryptographic
1926 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1927 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1928 * automatically enabled if required (i.e. if no PSA driver provides the
1929 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1930 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001931 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001932 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001933 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001934 *
John Durkop185764f2020-10-12 21:32:12 -07001935 * This feature is still experimental and is not ready for production since
1936 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001937 */
1938//#define MBEDTLS_PSA_CRYPTO_CONFIG
1939
1940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001942 *
1943 * Allow run-time checking of compile-time enabled features. Thus allowing users
1944 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001946 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001948 *
1949 * Comment this to disable run-time checking and save ROM space
1950 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001952
1953/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001954 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1955 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001956 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001957 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1958 * the set of trusted certificates through a callback instead of a linked
1959 * list.
1960 *
1961 * This is useful for example in environments where a large number of trusted
1962 * certificates is present and storing them in a linked list isn't efficient
1963 * enough, or when the set of trusted certificates changes frequently.
1964 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001965 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001966 * `mbedtls_ssl_conf_ca_cb()` for more information.
1967 *
1968 * Uncomment to enable trusted certificate callbacks.
1969 */
1970//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1971
1972/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001973 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001974 *
Chris Jones2c745862020-12-16 11:41:06 +00001975 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001976 *
Chris Jones2c745862020-12-16 11:41:06 +00001977 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001978 * and other functions/constants only used by these functions, thus reducing
1979 * the code footprint by several KB.
1980 */
Chris Jones2c745862020-12-16 11:41:06 +00001981//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001982
1983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001985 *
1986 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1987 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1988 *
1989 * Comment this macro to disallow using RSASSA-PSS in certificates.
1990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01001992/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001993
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001994/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001995 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001996 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001997 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001998 * \{
1999 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002000
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002001/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002003 *
2004 * Enable AES-NI support on x86-64.
2005 *
2006 * Module: library/aesni.c
2007 * Caller: library/aes.c
2008 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002010 *
2011 * This modules adds support for the AES-NI instructions on x86-64
2012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002013#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002014
2015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002017 *
2018 * Enable the AES block cipher.
2019 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002020 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002021 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002022 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002023 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002024 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002025 * This module enables the following ciphersuites (if other requisites are
2026 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2028 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2029 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2030 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2031 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2032 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2033 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2034 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2035 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2036 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2037 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2038 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2039 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2040 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2041 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2042 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2043 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2044 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2046 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2047 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2049 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2050 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2051 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2052 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2053 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2054 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2055 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2056 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2057 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2058 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2059 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2060 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2061 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2062 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2063 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2064 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2065 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2066 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2067 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2068 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2069 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2070 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2071 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2072 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2073 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2074 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2075 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2076 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2077 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2078 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2079 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2080 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2081 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2082 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2083 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2084 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002085 *
Paul Bakkercff68422013-09-15 20:43:33 +02002086 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002088#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002089
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002091 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002092 *
2093 * Enable the generic ASN1 parser.
2094 *
2095 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002096 * Caller: library/x509.c
2097 * library/dhm.c
2098 * library/pkcs12.c
2099 * library/pkcs5.c
2100 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002102#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002103
2104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002105 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002106 *
2107 * Enable the generic ASN1 writer.
2108 *
2109 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002110 * Caller: library/ecdsa.c
2111 * library/pkwrite.c
2112 * library/x509_create.c
2113 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002114 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002117
2118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002120 *
2121 * Enable the Base64 module.
2122 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002123 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002124 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002125 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002126 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002128#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002129
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002131 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002132 *
Paul Bakker9a736322012-11-14 12:39:52 +00002133 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002134 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002135 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002136 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002137 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002138 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002139 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002140 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002141 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002142 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002143 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002145 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002146 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002149
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002152 *
2153 * Enable the Camellia block cipher.
2154 *
Paul Bakker38119b12009-01-10 23:31:23 +00002155 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002156 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002157 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002158 * This module enables the following ciphersuites (if other requisites are
2159 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2161 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2162 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2163 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2164 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2165 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2166 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2167 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2168 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2169 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2170 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2171 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2172 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2173 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2174 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2175 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2176 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2177 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2178 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2179 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2180 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2181 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2182 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2183 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2184 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2185 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2186 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2187 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2188 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2189 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2190 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2191 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2192 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2193 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2194 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2195 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2196 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2197 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2198 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2199 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2200 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2201 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002204
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002205/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002206 * \def MBEDTLS_ARIA_C
2207 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002208 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002209 *
2210 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002211 * Caller: library/cipher.c
2212 *
2213 * This module enables the following ciphersuites (if other requisites are
2214 * enabled as well):
2215 *
2216 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2217 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2218 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2219 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2220 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2222 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2223 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2224 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2225 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2226 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2227 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2228 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2229 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2230 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2231 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2232 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2233 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2234 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2235 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2236 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2237 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2238 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2239 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2240 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2241 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2242 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2243 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2244 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2245 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2246 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2247 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2248 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2249 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2250 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2251 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2252 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002254 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002255#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002256
2257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002258 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002259 *
2260 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2261 *
2262 * Module: library/ccm.c
2263 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002264 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2265 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002266 *
2267 * This module enables the AES-CCM ciphersuites, if other requisites are
2268 * enabled as well.
2269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002271
2272/**
Daniel King34b822c2016-05-15 17:28:08 -03002273 * \def MBEDTLS_CHACHA20_C
2274 *
2275 * Enable the ChaCha20 stream cipher.
2276 *
2277 * Module: library/chacha20.c
2278 */
2279#define MBEDTLS_CHACHA20_C
2280
2281/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002282 * \def MBEDTLS_CHACHAPOLY_C
2283 *
2284 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2285 *
2286 * Module: library/chachapoly.c
2287 *
2288 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2289 */
2290#define MBEDTLS_CHACHAPOLY_C
2291
2292/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002294 *
2295 * Enable the generic cipher layer.
2296 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002297 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002298 * Caller: library/ccm.c
2299 * library/cmac.c
2300 * library/gcm.c
2301 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002302 * library/pkcs12.c
2303 * library/pkcs5.c
2304 * library/psa_crypto_aead.c
2305 * library/psa_crypto_mac.c
2306 * library/ssl_ciphersuites.c
2307 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002308 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002309 *
2310 * Uncomment to enable generic cipher wrappers.
2311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002313
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002314/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002315 * \def MBEDTLS_CMAC_C
2316 *
Simon Butcher327398a2016-10-05 14:09:11 +01002317 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2318 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002319 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002320 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2321 * implementation of the CMAC algorithm is provided by an alternate
2322 * implementation, that alternate implementation may opt to not support
2323 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2324 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002325 * Module: library/cmac.c
2326 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002327 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002328 *
2329 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002330#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002331
2332/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002333 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002334 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002335 * Enable the CTR_DRBG AES-based random generator.
2336 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002337 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002338 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002339 * \note To achieve a 256-bit security strength with CTR_DRBG,
2340 * you must use AES-256 *and* use sufficient entropy.
2341 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002342 *
2343 * Module: library/ctr_drbg.c
2344 * Caller:
2345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002347 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002348 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002351
2352/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002354 *
2355 * Enable the debug functions.
2356 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002357 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002358 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002359 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002360 * library/ssl_tls12_*.c
2361 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002362 *
2363 * This module provides debugging functions.
2364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002366
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002367/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002368 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002369 *
2370 * Enable the DES block cipher.
2371 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002372 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002373 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002374 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002375 *
Paul Bakkercff68422013-09-15 20:43:33 +02002376 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002377 *
2378 * \warning DES is considered a weak cipher and its use constitutes a
2379 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002382
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002383/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002385 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002386 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002387 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002388 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002389 * Caller: library/ssl_tls.c
2390 * library/ssl*_client.c
2391 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002392 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002393 * This module is used by the following key exchanges:
2394 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002395 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002396 * \warning Using DHE constitutes a security risk as it
2397 * is not possible to validate custom DH parameters.
2398 * If possible, it is recommended users should consider
2399 * preferring other methods of key exchange.
2400 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002401 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002404
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002405/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002407 *
2408 * Enable the elliptic curve Diffie-Hellman library.
2409 *
2410 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002411 * Caller: library/psa_crypto.c
2412 * library/ssl_tls.c
2413 * library/ssl*_client.c
2414 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002415 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002416 * This module is used by the following key exchanges:
2417 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002418 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002422
2423/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002425 *
2426 * Enable the elliptic curve DSA library.
2427 *
2428 * Module: library/ecdsa.c
2429 * Caller:
2430 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002431 * This module is used by the following key exchanges:
2432 * ECDHE-ECDSA
2433 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002434 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2435 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2436 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002437 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002438#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002439
2440/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002441 * \def MBEDTLS_ECJPAKE_C
2442 *
2443 * Enable the elliptic curve J-PAKE library.
2444 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002445 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2446 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002447 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002448 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002449 * Module: library/ecjpake.c
2450 * Caller:
2451 *
2452 * This module is used by the following key exchanges:
2453 * ECJPAKE
2454 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002455 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002456 *
2457 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2458 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002459 *
2460 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002461 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002462 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2463 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002464 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002465#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002466
2467/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002469 *
2470 * Enable the elliptic curve over GF(p) library.
2471 *
2472 * Module: library/ecp.c
2473 * Caller: library/ecdh.c
2474 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002475 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002476 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002477 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002479#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002480
2481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002483 *
2484 * Enable the platform-specific entropy code.
2485 *
2486 * Module: library/entropy.c
2487 * Caller:
2488 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002490 *
2491 * This module provides a generic entropy pool
2492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002493#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002494
2495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002497 *
2498 * Enable error code to error string conversion.
2499 *
2500 * Module: library/error.c
2501 * Caller:
2502 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002504 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002506
2507/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002509 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002510 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002511 *
2512 * Module: library/gcm.c
2513 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002514 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2515 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002516 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002517 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2518 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002519 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002520#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002521
2522/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002523 * \def MBEDTLS_HKDF_C
2524 *
2525 * Enable the HKDF algorithm (RFC 5869).
2526 *
2527 * Module: library/hkdf.c
2528 * Caller:
2529 *
2530 * Requires: MBEDTLS_MD_C
2531 *
2532 * This module adds support for the Hashed Message Authentication Code
2533 * (HMAC)-based key derivation function (HKDF).
2534 */
2535#define MBEDTLS_HKDF_C
2536
2537/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002539 *
2540 * Enable the HMAC_DRBG random generator.
2541 *
2542 * Module: library/hmac_drbg.c
2543 * Caller:
2544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002546 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002547 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002548 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002550
2551/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002552 * \def MBEDTLS_LMS_C
2553 *
2554 * Enable the LMS stateful-hash asymmetric signature algorithm.
2555 *
2556 * Module: library/lms.c
2557 * Caller:
2558 *
Raef Colesab4f8742022-09-01 12:24:31 +01002559 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002560 *
Raef Colesab4f8742022-09-01 12:24:31 +01002561 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002562 */
2563#define MBEDTLS_LMS_C
2564
2565/**
Raef Colesab4f8742022-09-01 12:24:31 +01002566 * \def MBEDTLS_LMS_PRIVATE
2567 *
2568 * Enable LMS private-key operations and signing code. Functions enabled by this
2569 * option are experimental, and should not be used in production.
2570 *
2571 * Requires: MBEDTLS_LMS_C
2572 *
2573 * Uncomment to enable the LMS signature algorithm and private key operations.
2574 */
Raef Coles5127e852022-10-07 10:35:56 +01002575//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002576
2577/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002578 * \def MBEDTLS_NIST_KW_C
2579 *
2580 * Enable the Key Wrapping mode for 128-bit block ciphers,
2581 * as defined in NIST SP 800-38F. Only KW and KWP modes
2582 * are supported. At the moment, only AES is approved by NIST.
2583 *
2584 * Module: library/nist_kw.c
2585 *
2586 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2587 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002588#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002589
2590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002592 *
2593 * Enable the generic message digest layer.
2594 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002595 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2596 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2597 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002598 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002599 * Caller: library/constant_time.c
2600 * library/ecdsa.c
2601 * library/ecjpake.c
2602 * library/hkdf.c
2603 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002604 * library/pk.c
2605 * library/pkcs5.c
2606 * library/pkcs12.c
2607 * library/psa_crypto_ecp.c
2608 * library/psa_crypto_rsa.c
2609 * library/rsa.c
2610 * library/ssl_cookie.c
2611 * library/ssl_msg.c
2612 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002613 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002614 * library/x509_crt.c
2615 * library/x509write_crt.c
2616 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002617 *
2618 * Uncomment to enable generic message digest wrappers.
2619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002621
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002624 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002625 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002626 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002627 * Module: library/md5.c
2628 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002629 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002630 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002631 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002632 * This module is required for TLS 1.2 depending on the handshake parameters.
2633 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2634 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002635 *
2636 * \warning MD5 is considered a weak message digest and its use constitutes a
2637 * security risk. If possible, we recommend avoiding dependencies on
2638 * it, and considering stronger message digests instead.
2639 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002640 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002642
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002643/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002645 *
2646 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002647 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002648 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002649 *
2650 * Module: library/memory_buffer_alloc.c
2651 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * Requires: MBEDTLS_PLATFORM_C
2653 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002654 *
2655 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002656 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002658
2659/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002661 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002662 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2663 *
Simon Butcherd567a232016-03-09 20:19:21 +00002664 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2665 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002666 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002667 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002668 * \note See also our Knowledge Base article about porting to a new
2669 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002670 * 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 +00002671 *
Andres AG788aa4a2016-09-14 14:32:09 +01002672 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002673 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002674 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002677
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002679 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002680 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002681 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002682 *
2683 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002684 * Caller: library/asn1write.c
2685 * library/pkcs5.c
2686 * library/pkparse.c
2687 * library/pkwrite.c
2688 * library/rsa.c
2689 * library/x509.c
2690 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002691 * library/x509_crl.c
2692 * library/x509_crt.c
2693 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002694 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002695 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002696 *
2697 * This modules translates between OIDs and internal values.
2698 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002699#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002700
2701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002703 *
2704 * Enable VIA Padlock support on x86.
2705 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002706 * Module: library/padlock.c
2707 * Caller: library/aes.c
2708 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002710 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002711 * This modules adds support for the VIA PadLock on x86.
2712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002713#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002714
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002717 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002718 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002719 *
2720 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002721 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002722 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002723 * library/x509_crl.c
2724 * library/x509_crt.c
2725 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002726 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002728 *
Paul Bakkercff68422013-09-15 20:43:33 +02002729 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002730 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002731#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002732
2733/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002734 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002735 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002736 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002737 *
2738 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002739 * Caller: library/pkwrite.c
2740 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002741 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002742 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002743 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002744 *
2745 * This modules adds support for encoding / writing PEM files.
2746 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002748
2749/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002751 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002752 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002753 *
2754 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002755 * Caller: library/psa_crypto_rsa.c
2756 * library/ssl_tls.c
2757 * library/ssl*_client.c
2758 * library/ssl*_server.c
2759 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002760 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002761 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002762 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002763 * Uncomment to enable generic public key wrappers.
2764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002766
2767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002768 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002769 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002770 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002771 *
2772 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002773 * Caller: library/x509_crt.c
2774 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002775 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002776 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002777 *
2778 * Uncomment to enable generic public key parse functions.
2779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002780#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002781
2782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002784 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002785 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002786 *
2787 * Module: library/pkwrite.c
2788 * Caller: library/x509write.c
2789 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002791 *
2792 * Uncomment to enable generic public key write functions.
2793 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002794#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002795
2796/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002797 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002798 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002799 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002800 *
2801 * Module: library/pkcs5.c
2802 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002803 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2804 *
2805 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2806 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002807 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002808 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002809 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002810 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2811 * this module in builds where MBEDTLS_MD_C is disabled.
2812 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002813 * This module adds support for the PKCS#5 functions.
2814 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002815#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002816
2817/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002818 * \def MBEDTLS_PKCS7_C
2819 *
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002820 * This feature is a work in progress and not ready for production. The API may
2821 * change. Testing and validation is incomplete.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002822 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002823 * Enable PKCS7 core for using PKCS7 formatted signatures.
2824 * RFC Link - https://tools.ietf.org/html/rfc2315
2825 *
2826 * Module: library/pkcs7.c
2827 *
2828 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002829 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2830 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002831 *
2832 * This module is required for the PKCS7 parsing modules.
2833 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002834//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002835
2836/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002837 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002838 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002839 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002840 * Adds algorithms for parsing PKCS#8 encrypted private keys
2841 *
2842 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002843 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002844 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002845 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2846 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2847 *
2848 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2849 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002850 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002851 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002852 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002853 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2854 * this module in builds where MBEDTLS_MD_C is disabled.
2855 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002856 * This module enables PKCS#12 functions.
2857 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002859
2860/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002862 *
2863 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002864 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2867 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002868 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002869 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002870 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002871 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002872 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002873 * Module: library/platform.c
2874 * Caller: Most other .c files
2875 *
2876 * This module enables abstraction of common (libc) functions.
2877 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002878#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002879
2880/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002881 * \def MBEDTLS_POLY1305_C
2882 *
2883 * Enable the Poly1305 MAC algorithm.
2884 *
2885 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002886 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002887 */
2888#define MBEDTLS_POLY1305_C
2889
2890/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002891 * \def MBEDTLS_PSA_CRYPTO_C
2892 *
2893 * Enable the Platform Security Architecture cryptography API.
2894 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002895 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002896 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002897 * Requires: MBEDTLS_CIPHER_C,
2898 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002899 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002900 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002901 *
2902 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002903#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002904
2905/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002906 * \def MBEDTLS_PSA_CRYPTO_SE_C
2907 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002908 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002909 * cryptography API.
2910 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002911 * \deprecated This feature is deprecated. Please switch to the driver
2912 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002913 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002914 * Module: library/psa_crypto_se.c
2915 *
2916 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2917 *
2918 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002919//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002920
2921/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002922 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2923 *
2924 * Enable the Platform Security Architecture persistent key storage.
2925 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002926 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002927 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002928 * Requires: MBEDTLS_PSA_CRYPTO_C,
2929 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2930 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002931 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002932#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002933
2934/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002935 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002936 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002937 * Enable the emulation of the Platform Security Architecture
2938 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002939 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002940 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002941 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002942 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002943 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002944#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002945
2946/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002948 *
2949 * Enable the RIPEMD-160 hash algorithm.
2950 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002951 * Module: library/ripemd160.c
2952 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002953 *
2954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002955#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002956
2957/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002959 *
2960 * Enable the RSA public-key cryptosystem.
2961 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002962 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002963 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002964 * Caller: library/pk.c
2965 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002966 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002967 * library/ssl*_client.c
2968 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002969 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002970 * This module is used by the following key exchanges:
2971 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002972 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002976
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002978 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002979 *
2980 * Enable the SHA1 cryptographic hash algorithm.
2981 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002982 * Module: library/sha1.c
2983 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002984 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002985 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002986 * This module is required for TLS 1.2 depending on the handshake parameters,
2987 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002988 *
2989 * \warning SHA-1 is considered a weak message digest and its use constitutes
2990 * a security risk. If possible, we recommend avoiding dependencies
2991 * on it, and considering stronger message digests instead.
2992 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002994#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002995
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002996/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002997 * \def MBEDTLS_SHA224_C
2998 *
2999 * Enable the SHA-224 cryptographic hash algorithm.
3000 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003001 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003002 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003003 *
3004 * Module: library/sha256.c
3005 * Caller: library/md.c
3006 * library/ssl_cookie.c
3007 *
3008 * This module adds support for SHA-224.
3009 */
3010#define MBEDTLS_SHA224_C
3011
3012/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003014 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003015 * Enable the SHA-256 cryptographic hash algorithm.
3016 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003017 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003018 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003019 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003020 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003021 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003022 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003023 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003024 * library/ssl*_client.c
3025 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003026 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003027 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003028 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003029 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003031
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003032/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003033 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3034 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003035 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3036 * with the ARMv8 cryptographic extensions if they are available at runtime.
3037 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003038 *
3039 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3040 * for a non-Aarch64 build it will be silently ignored.
3041 *
3042 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3043 * of \c -march=armv8-a+crypto.
3044 *
3045 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3046 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3047 *
3048 * Requires: MBEDTLS_SHA256_C.
3049 *
3050 * Module: library/sha256.c
3051 *
3052 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3053 * and use them if available.
3054 */
3055//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3056
3057/**
3058 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3059 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003060 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3061 * with the ARMv8 cryptographic extensions, which must be available at runtime
3062 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003063 *
3064 * \note This allows builds with a smaller code size than with
3065 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3066 *
3067 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3068 * of \c -march=armv8-a+crypto.
3069 *
3070 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3071 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3072 *
3073 * Requires: MBEDTLS_SHA256_C.
3074 *
3075 * Module: library/sha256.c
3076 *
3077 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3078 * unconditionally.
3079 */
3080//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3081
3082/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003083 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003084 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003085 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003086 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003087 * Requires: MBEDTLS_SHA512_C
3088 *
3089 * Module: library/sha512.c
3090 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003091 * library/psa_crypto_hash.c
3092 * library/ssl_tls.c
3093 * library/ssl*_client.c
3094 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003095 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003096 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003097 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003098#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003099
3100/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003102 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003103 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003104 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003105 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003106 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003107 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003108 * library/ssl_tls.c
3109 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003110 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003111 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003114
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003115/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003116 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3117 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003118 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3119 * with the ARMv8 cryptographic extensions if they are available at runtime.
3120 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003121 *
3122 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3123 * for a non-Aarch64 build it will be silently ignored.
3124 *
3125 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3126 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3127 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3128 * fastest code.
3129 *
3130 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3131 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3132 *
3133 * Requires: MBEDTLS_SHA512_C.
3134 *
3135 * Module: library/sha512.c
3136 *
3137 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3138 * and use them if available.
3139 */
3140//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3141
3142/**
3143 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3144 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003145 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3146 * with the ARMv8 cryptographic extensions, which must be available at runtime
3147 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003148 *
3149 * \note This allows builds with a smaller code size than with
3150 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3151 *
3152 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3153 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3154 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3155 * fastest code.
3156 *
3157 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3158 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3159 *
3160 * Requires: MBEDTLS_SHA512_C.
3161 *
3162 * Module: library/sha512.c
3163 *
3164 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3165 * unconditionally.
3166 */
3167//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3168
3169/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003171 *
3172 * Enable simple SSL cache implementation.
3173 *
3174 * Module: library/ssl_cache.c
3175 * Caller:
3176 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003177 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003178 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003180
3181/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003183 *
3184 * Enable basic implementation of DTLS cookies for hello verification.
3185 *
3186 * Module: library/ssl_cookie.c
3187 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003189#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003190
3191/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003192 * \def MBEDTLS_SSL_TICKET_C
3193 *
3194 * Enable an implementation of TLS server-side callbacks for session tickets.
3195 *
3196 * Module: library/ssl_ticket.c
3197 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003198 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003199 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3200 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003201 */
3202#define MBEDTLS_SSL_TICKET_C
3203
3204/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003206 *
3207 * Enable the SSL/TLS client code.
3208 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003209 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003210 * Caller:
3211 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003213 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003214 * This module is required for SSL/TLS client support.
3215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003217
Paul Bakker9a736322012-11-14 12:39:52 +00003218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003219 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003220 *
3221 * Enable the SSL/TLS server code.
3222 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003223 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003224 * Caller:
3225 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003226 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003227 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003228 * This module is required for SSL/TLS server support.
3229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003231
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003232/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003233 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003234 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003235 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003236 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003237 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003238 * Caller: library/ssl*_client.c
3239 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003240 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3242 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003243 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003244 * This module is required for SSL/TLS.
3245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003246#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003247
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003250 *
3251 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003252 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003253 * contexts are not shared between threads. If you do intend to use contexts
3254 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003255 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003256 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003257 *
3258 * Module: library/threading.c
3259 *
3260 * This allows different threading implementations (self-implemented or
3261 * provided).
3262 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263 * You will have to enable either MBEDTLS_THREADING_ALT or
3264 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003265 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003266 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003268//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003269
3270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003272 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003273 * Enable the semi-portable timing interface.
3274 *
Simon Butcherd567a232016-03-09 20:19:21 +00003275 * \note The provided implementation only works on POSIX/Unix (including Linux,
3276 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003277 * module and provide your own implementations of the callbacks needed by
3278 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3279 * your own implementation of the whole module by setting
3280 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003281 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003282 * \note The timing module will include time.h on suitable platforms
3283 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3284 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3285 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003286 * \note See also our Knowledge Base article about porting to a new
3287 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003288 * 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 +00003289 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003290 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003293
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003294/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003296 *
3297 * Enable run-time version information.
3298 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003299 * Module: library/version.c
3300 *
3301 * This module provides run-time version information.
3302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003304
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003305/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003307 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003308 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003309 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003310 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003311 * Caller: library/x509_crl.c
3312 * library/x509_crt.c
3313 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003315 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003316 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3317 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003318 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3319 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003320 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003321 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003322 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003324
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003326 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003327 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003328 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003329 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003330 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003331 * Caller: library/ssl_tls.c
3332 * library/ssl*_client.c
3333 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003334 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003336 *
3337 * This module is required for X.509 certificate parsing.
3338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003340
3341/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003343 *
3344 * Enable X.509 CRL parsing.
3345 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003346 * Module: library/x509_crl.c
3347 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003348 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003350 *
3351 * This module is required for X.509 CRL parsing.
3352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003354
3355/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357 *
3358 * Enable X.509 Certificate Signing Request (CSR) parsing.
3359 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003360 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003361 * Caller: library/x509_crt_write.c
3362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003364 *
3365 * This module is used for reading X.509 certificate request.
3366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003368
3369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003371 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003372 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003373 *
3374 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003375 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003376 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003377 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3378 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003379 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3380 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003381 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003382 * This module is the basis for creating X.509 certificates and CSRs.
3383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003384#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003385
3386/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003388 *
3389 * Enable creating X.509 certificates.
3390 *
3391 * Module: library/x509_crt_write.c
3392 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003393 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003394 *
3395 * This module is required for X.509 certificate creation.
3396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003398
3399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003401 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003402 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003403 *
3404 * Module: library/x509_csr_write.c
3405 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003406 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003407 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003408 * This module is required for X.509 certificate request writing.
3409 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003411
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003412/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003413
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003414/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003415 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003416 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003417 * This section contains Mbed TLS build settings that are not associated
3418 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003419 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003420 * \{
3421 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003422
Gilles Peskinea02c1242022-03-16 17:03:19 +01003423/**
3424 * \def MBEDTLS_CONFIG_FILE
3425 *
3426 * If defined, this is a header which will be included instead of
3427 * `"mbedtls/mbedtls_config.h"`.
3428 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003429 * Unlike other configuration options, this one must be defined on the
3430 * compiler command line: a definition in `mbedtls_config.h` would have
3431 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003432 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003433 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003434 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003435 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003436 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003437 * The value of this symbol is typically a path in double quotes, either
3438 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003439 */
3440//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3441
3442/**
3443 * \def MBEDTLS_USER_CONFIG_FILE
3444 *
3445 * If defined, this is a header which will be included after
3446 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003447 * This allows you to modify the default configuration, including the ability
3448 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003449 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003450 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003451 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003452 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003453 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003454 * The value of this symbol is typically a path in double quotes, either
3455 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003456 */
3457//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3458
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003459/**
3460 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3461 *
3462 * If defined, this is a header which will be included instead of
3463 * `"psa/crypto_config.h"`.
3464 * This header file specifies which cryptographic mechanisms are available
3465 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3466 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3467 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003468 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003469 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003470 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003471 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003472 * The value of this symbol is typically a path in double quotes, either
3473 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003474 */
3475//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3476
3477/**
3478 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3479 *
3480 * If defined, this is a header which will be included after
3481 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003482 * This allows you to modify the default configuration, including the ability
3483 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003484 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003485 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003486 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003487 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003488 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003489 * The value of this symbol is typically a path in double quotes, either
3490 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003491 */
3492//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3493
Gilles Peskineba4162a2022-04-11 17:04:38 +02003494/** \} name SECTION: General configuration options */
3495
3496/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003497 * \name SECTION: Module configuration options
3498 *
3499 * This section allows for the setting of module specific sizes and
3500 * configuration options. The default values are already present in the
3501 * relevant header files and should suffice for the regular use cases.
3502 *
3503 * Our advice is to enable options and change their values here
3504 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003505 * \{
3506 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003507/* The Doxygen documentation here is used when a user comments out a
3508 * setting and runs doxygen themselves. On the other hand, when we typeset
3509 * the full documentation including disabled settings, the documentation
3510 * in specific modules' header files is used if present. When editing this
3511 * file, make sure that each option is documented in exactly one place,
3512 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3513 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003514
Paul Bakker088c5c52014-04-25 11:11:10 +02003515/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003516//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003518
Paul Bakker088c5c52014-04-25 11:11:10 +02003519/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3521//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3522//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3523//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3524//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003525
Paul Bakker088c5c52014-04-25 11:11:10 +02003526/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003527//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3528//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3529//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3530//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003531
Paul Bakker088c5c52014-04-25 11:11:10 +02003532/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003533//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003535
Paul Bakker088c5c52014-04-25 11:11:10 +02003536/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3538//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003539//#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 +01003540
Paul Bakker088c5c52014-04-25 11:11:10 +02003541/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003543
Paul Bakker088c5c52014-04-25 11:11:10 +02003544/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003545//#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 +02003546//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003548//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003550//#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 +02003551//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3552//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003553/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003554//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003555//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3556//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003557//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3558//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3559//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003561/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3562/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003563//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003564//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3565//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003566//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003567//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3568//#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 +02003569//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3570//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003571/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003573//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003574//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3575//#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 +02003576
Gilles Peskine3f106f72021-09-23 17:42:39 +02003577/** \def MBEDTLS_CHECK_RETURN
3578 *
3579 * This macro is used at the beginning of the declaration of a function
3580 * to indicate that its return value should be checked. It should
3581 * instruct the compiler to emit a warning or an error if the function
3582 * is called without checking its return value.
3583 *
3584 * There is a default implementation for popular compilers in platform_util.h.
3585 * You can override the default implementation by defining your own here.
3586 *
3587 * If the implementation here is empty, this will effectively disable the
3588 * checking of functions' return values.
3589 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003590//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003591
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003592/** \def MBEDTLS_IGNORE_RETURN
3593 *
3594 * This macro requires one argument, which should be a C function call.
3595 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3596 * warning is suppressed.
3597 */
3598//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3599
Gilles Peskineed038902020-11-13 21:33:21 +01003600/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003601/**
Gilles Peskineed038902020-11-13 21:33:21 +01003602 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3603 * PSA crypto subsystem.
3604 *
3605 * If this option is unset:
3606 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003607 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003608 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3609 * on unspecified heuristics.
3610 */
3611//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3612
Steven Cooreman863470a2021-02-15 14:03:19 +01003613/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003614 * Restrict the PSA library to supporting a maximum amount of simultaneously
3615 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3616 * volatile key, or a persistent key which is loaded temporarily by the
3617 * library as part of a crypto operation in flight.
3618 *
3619 * If this option is unset, the library will fall back to a default value of
3620 * 32 keys.
3621 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003622//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003623
Paul Bakker088c5c52014-04-25 11:11:10 +02003624/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003625//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3626//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003627
Paul Bakker088c5c52014-04-25 11:11:10 +02003628/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003629
Angus Grattond8213d02016-05-25 20:56:48 +10003630/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3631 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003632 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003633 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003634 * This determines the size of the incoming TLS I/O buffer in such a way
3635 * that it is capable of holding the specified amount of plaintext data,
3636 * regardless of the protection mechanism used.
3637 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003638 * \note When using a value less than the default of 16KB on the client, it is
3639 * recommended to use the Maximum Fragment Length (MFL) extension to
3640 * inform the server about this limitation. On the server, there
3641 * is no supported, standardized way of informing the client about
3642 * restriction on the maximum size of incoming messages, and unless
3643 * the limitation has been communicated by other means, it is recommended
3644 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3645 * while keeping the default value of 16KB for the incoming buffer.
3646 *
David Horstmann95d516f2021-05-04 18:36:56 +01003647 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003648 */
3649//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3650
Gilles Peskined3d02902020-03-04 21:35:27 +01003651/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3652 *
3653 * The maximum length of CIDs used for incoming DTLS messages.
3654 *
3655 */
3656//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3657
3658/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3659 *
3660 * The maximum length of CIDs used for outgoing DTLS messages.
3661 *
3662 */
3663//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3664
TRodziewicze8dd7092021-05-12 14:19:11 +02003665/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003666 *
3667 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003668 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003669 *
3670 * The padding will always be chosen so that the length of the
3671 * padded plaintext is a multiple of the value of this option.
3672 *
3673 * Note: A value of \c 1 means that no padding will be used
3674 * for outgoing records.
3675 *
3676 * Note: On systems lacking division instructions,
3677 * a power of two should be preferred.
3678 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003679//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003680
Angus Grattond8213d02016-05-25 20:56:48 +10003681/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3682 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003683 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003684 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003685 * This determines the size of the outgoing TLS I/O buffer in such a way
3686 * that it is capable of holding the specified amount of plaintext data,
3687 * regardless of the protection mechanism used.
3688 *
Angus Grattond8213d02016-05-25 20:56:48 +10003689 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3690 * the default inward 16384 byte buffer to conform to the TLS specification.
3691 *
3692 * The minimum required outward buffer size is determined by the handshake
3693 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3694 * The specific size requirement depends on the configured ciphers and any
3695 * certificate data which is sent during the handshake.
3696 *
David Horstmann95d516f2021-05-04 18:36:56 +01003697 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003698 */
3699//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3700
Hanno Beckere0b150f2018-08-21 15:51:03 +01003701/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3702 *
3703 * Maximum number of heap-allocated bytes for the purpose of
3704 * DTLS handshake message reassembly and future message buffering.
3705 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003706 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003707 * to account for a reassembled handshake message of maximum size,
3708 * together with its reassembly bitmap.
3709 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003710 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003711 * should be sufficient for all practical situations as it allows
3712 * to reassembly a large handshake message (such as a certificate)
3713 * while buffering multiple smaller handshake messages.
3714 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003715 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003716//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003718//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3719//#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 +02003720
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003721/**
3722 * Complete list of ciphersuites to use, in order of preference.
3723 *
3724 * \warning No dependency checking is done on that field! This option can only
3725 * be used to restrict the set of available ciphersuites. It is your
3726 * responsibility to make sure the needed modules are active.
3727 *
3728 * Use this to save a few hundred bytes of ROM (default ordering of all
3729 * available ciphersuites) and a few to a few hundred bytes of RAM.
3730 *
3731 * The value below is only an example, not the default.
3732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003733//#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 +02003734
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003735/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003736//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003737//#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 +01003738
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003739/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003740 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003741 * mbedtls_platform_zeroize(). This replaces the default implementation in
3742 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003743 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003744 * mbedtls_platform_zeroize() is a widely used function across the library to
3745 * zero a block of memory. The implementation is expected to be secure in the
3746 * sense that it has been written to prevent the compiler from removing calls
3747 * to mbedtls_platform_zeroize() as part of redundant code elimination
3748 * optimizations. However, it is difficult to guarantee that calls to
3749 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3750 * versions of the C language standards do not provide a secure implementation
3751 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3752 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003753 * example by using directives specific to their compiler, features from newer
3754 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003755 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003756 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003757//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003758
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003759/**
3760 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003761 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003762 * platform_util.c.
3763 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003764 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003765 * library will try to use safer implementations of this function, such as
3766 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003767 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003768 * using the standard gmtime(). In this case, calls from the library to
3769 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003770 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003771 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003772 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3773 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3774 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003775 */
Hanno Becker6a739782018-09-05 15:06:19 +01003776//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003777
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003778/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003779 * Enable the verified implementations of ECDH primitives from Project Everest
3780 * (currently only Curve25519). This feature changes the layout of ECDH
3781 * contexts and therefore is a compatibility break for applications that access
3782 * fields of a mbedtls_ecdh_context structure directly. See also
3783 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003784 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003785//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003786
Gilles Peskine611179c2022-04-13 23:04:48 +02003787/** \} name SECTION: Module configuration options */