blob: 8f452369401092968a6263021e17ebeed2d76a52 [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 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001149 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001152
Steven Cooreman6801f082021-02-19 17:21:22 +01001153/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1154 *
1155 * Enable support for platform built-in keys. If you enable this feature,
1156 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1157 * See the documentation of that function for more information.
1158 *
1159 * Built-in keys are typically derived from a hardware unique key or
1160 * stored in a secure element.
1161 *
1162 * Requires: MBEDTLS_PSA_CRYPTO_C.
1163 *
1164 * \warning This interface is experimental and may change or be removed
1165 * without notice.
1166 */
1167//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1168
Ronald Cron3768ac12021-01-26 16:58:00 +01001169/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1170 *
1171 * Enable support for PSA crypto client.
1172 *
1173 * \note This option allows to include the code necessary for a PSA
1174 * crypto client when the PSA crypto implementation is not included in
1175 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1176 * code to set and get PSA key attributes.
1177 * The development of PSA drivers partially relying on the library to
1178 * fulfill the hardware gaps is another possible usage of this option.
1179 *
1180 * \warning This interface is experimental and may change or be removed
1181 * without notice.
1182 */
1183//#define MBEDTLS_PSA_CRYPTO_CLIENT
1184
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001185/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1186 *
1187 * Enable support for the experimental PSA crypto driver interface.
1188 *
John Durkop185764f2020-10-12 21:32:12 -07001189 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001190 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001191 * \warning This interface is experimental. We intend to maintain backward
1192 * compatibility with application code that relies on drivers,
1193 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001194 */
1195//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1196
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001197/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1198 *
1199 * Make the PSA Crypto module use an external random generator provided
1200 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1201 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001202 * \note This random generator must deliver random numbers with cryptographic
1203 * quality and high performance. It must supply unpredictable numbers
1204 * with a uniform distribution. The implementation of this function
1205 * is responsible for ensuring that the random generator is seeded
1206 * with sufficient entropy. If you have a hardware TRNG which is slow
1207 * or delivers non-uniform output, declare it as an entropy source
1208 * with mbedtls_entropy_add_source() instead of enabling this option.
1209 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001210 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001211 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1212 * and define a function called mbedtls_psa_external_get_random()
1213 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001214 * ```
1215 * psa_status_t mbedtls_psa_external_get_random(
1216 * mbedtls_psa_external_random_context_t *context,
1217 * uint8_t *output, size_t output_size, size_t *output_length);
1218 * );
1219 * ```
1220 * The \c context value is initialized to 0 before the first call.
1221 * The function must fill the \c output buffer with \p output_size bytes
1222 * of random data and set \c *output_length to \p output_size.
1223 *
1224 * Requires: MBEDTLS_PSA_CRYPTO_C
1225 *
1226 * \warning If you enable this option, code that uses the PSA cryptography
1227 * interface will not use any of the entropy sources set up for
1228 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1229 * enables.
1230 *
1231 * \note This option is experimental and may be removed without notice.
1232 */
1233//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1234
Paul Bakker9dcc3222011-03-08 14:16:06 +00001235/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001236 * \def MBEDTLS_PSA_CRYPTO_SPM
1237 *
1238 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1239 * Partition Manager) integration which separates the code into two parts: a
1240 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1241 * Environment).
1242 *
1243 * Module: library/psa_crypto.c
1244 * Requires: MBEDTLS_PSA_CRYPTO_C
1245 *
1246 */
1247//#define MBEDTLS_PSA_CRYPTO_SPM
1248
1249/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001250 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001251 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001252 * Enable support for entropy injection at first boot. This feature is
1253 * required on systems that do not have a built-in entropy source (TRNG).
1254 * This feature is currently not supported on systems that have a built-in
1255 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001256 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001257 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001258 *
1259 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001260//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001261
1262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001264 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001265 * Do not use the Chinese Remainder Theorem
1266 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001267 *
1268 * Uncomment this macro to disable the use of CRT in RSA.
1269 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001272
1273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001275 *
1276 * Enable the checkup functions (*_self_test).
1277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001279
1280/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001281 * \def MBEDTLS_SHA256_SMALLER
1282 *
1283 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1284 * lower performance.
1285 *
Adam Wolf039080f2019-09-10 09:53:08 -05001286 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001287 * performance and size. This version optimizes more aggressively for size at
1288 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1289 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1290 * 30%.
1291 *
1292 * Uncomment to enable the smaller implementation of SHA256.
1293 */
1294//#define MBEDTLS_SHA256_SMALLER
1295
1296/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001297 * \def MBEDTLS_SHA512_SMALLER
1298 *
1299 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1300 * lower performance.
1301 *
1302 * Uncomment to enable the smaller implementation of SHA512.
1303 */
1304//#define MBEDTLS_SHA512_SMALLER
1305
1306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001308 *
1309 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001310 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001311 * with other servers, only debugging of failures is harder.
1312 *
1313 * The advantage of not sending alert messages, is that no information is given
1314 * about reasons for failures thus preventing adversaries of gaining intel.
1315 *
1316 * Enable sending of all alert messages
1317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001319
1320/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001321 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1322 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001323 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001324 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001325 * in the underlying transport. The CID functionality is described
1326 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001327 *
1328 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001329 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1330 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1331 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001332 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001333 * The maximum lengths of outgoing and incoming CIDs can be configured
1334 * through the options
1335 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1336 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1337 *
1338 * Requires: MBEDTLS_SSL_PROTO_DTLS
1339 *
1340 * Uncomment to enable the Connection ID extension.
1341 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001342#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1343
1344
1345/**
1346 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1347 *
1348 * Defines whether RFC 9146 (default) or the legacy version
1349 * (version draft-ietf-tls-dtls-connection-id-05,
1350 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1351 * is used.
1352 *
1353 * Set the value to 0 for the standard version, and
1354 * 1 for the legacy draft version.
1355 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001356 * \deprecated Support for the legacy version of the DTLS
1357 * Connection ID feature is deprecated. Please
1358 * switch to the standardized version defined
1359 * in RFC 9146 enabled by utilizing
1360 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1361 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1362 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001363 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1364 */
1365#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001366
1367/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001368 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1369 *
1370 * Enable asynchronous external private key operations in SSL. This allows
1371 * you to configure an SSL connection to call an external cryptographic
1372 * module to perform private key operations instead of performing the
1373 * operation inside the library.
1374 *
1375 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001376//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001377
1378/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001379 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1380 *
1381 * Enable serialization of the TLS context structures, through use of the
1382 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1383 *
1384 * This pair of functions allows one side of a connection to serialize the
1385 * context associated with the connection, then free or re-use that context
1386 * while the serialized state is persisted elsewhere, and finally deserialize
1387 * that state to a live context for resuming read/write operations on the
1388 * connection. From a protocol perspective, the state of the connection is
1389 * unaffected, in particular this is entirely transparent to the peer.
1390 *
1391 * Note: this is distinct from TLS session resumption, which is part of the
1392 * protocol and fully visible by the peer. TLS session resumption enables
1393 * establishing new connections associated to a saved session with shorter,
1394 * lighter handshakes, while context serialization is a local optimization in
1395 * handling a single, potentially long-lived connection.
1396 *
1397 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1398 * saved after the handshake to allow for more efficient serialization, so if
1399 * you don't need this feature you'll save RAM by disabling it.
1400 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001401 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1402 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001403 * Comment to disable the context serialization APIs.
1404 */
1405#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1406
1407/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001408 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001409 *
1410 * Enable the debug messages in SSL module for all issues.
1411 * Debug messages have been disabled in some places to prevent timing
1412 * attacks due to (unbalanced) debugging function calls.
1413 *
1414 * If you need all error reporting you should enable this during debugging,
1415 * but remove this for production servers that should log as well.
1416 *
1417 * Uncomment this macro to report all debug messages on errors introducing
1418 * a timing side-channel.
1419 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001422
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001424 *
1425 * Enable support for Encrypt-then-MAC, RFC 7366.
1426 *
1427 * This allows peers that both support it to use a more robust protection for
1428 * ciphersuites using CBC, providing deep resistance against timing attacks
1429 * on the padding or underlying cipher.
1430 *
1431 * This only affects CBC ciphersuites, and is useless if none is defined.
1432 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001433 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001434 *
1435 * Comment this macro to disable support for Encrypt-then-MAC
1436 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001439/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001440 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001441 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1442 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001443 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001444 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001445 * attacks, but it is recommended to always use it (even if you disable
1446 * renegotiation), since it actually fixes a more fundamental issue in the
1447 * original SSL/TLS design, and has implications beyond Triple Handshake.
1448 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001449 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001450 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001451 * Comment this macro to disable support for Extended Master Secret.
1452 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001453#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001454
Paul Bakkerd66f0702013-01-31 16:57:45 +01001455/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001456 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1457 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001458 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001459 * giving access to the peer's certificate after completion of the handshake.
1460 *
1461 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1462 * recommended to disable this option for reduced RAM usage.
1463 *
1464 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1465 * defined, but always returns \c NULL.
1466 *
1467 * \note This option has no influence on the protection against the
1468 * triple handshake attack. Even if it is disabled, Mbed TLS will
1469 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001470 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001471 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001472 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1473 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001474 * Comment this macro to disable storing the peer's certificate
1475 * after the handshake.
1476 */
1477#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1478
1479/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001480 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001481 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001482 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001483 *
1484 * The two main uses of renegotiation are (1) refresh keys on long-lived
1485 * connections and (2) client authentication after the initial handshake.
1486 * If you don't need renegotiation, it's probably better to disable it, since
1487 * it has been associated with security issues in the past and is easy to
1488 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001489 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001490 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001491 *
1492 * \note Even if this option is disabled, both client and server are aware
1493 * of the Renegotiation Indication Extension (RFC 5746) used to
1494 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1495 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1496 * configuration of this extension).
1497 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001500
1501/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001502 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001503 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001504 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001505 *
1506 * Comment this macro to disable support for the max_fragment_length extension
1507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001509
1510/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001511 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001512 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001513 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001514 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001515 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1516 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1517 * With MBEDTLS_USE_PSA_CRYPTO:
1518 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1519 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001520 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001521 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1522 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001523 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001524 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001527
1528/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001529 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001530 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001531 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001532 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001533 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1534 * pre-shared keys are not supported.
1535 * See docs/architecture/tls13-support.md for a description of the TLS
1536 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001537 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001538 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001539 * Requires: MBEDTLS_PSA_CRYPTO_C
1540 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001541 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1542 * for most operations, if you want it to only use PSA for all crypto
1543 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1544 * operations, and functions that are common with TLS 1.2 (record protection,
1545 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001546 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001547 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001548 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001549//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001550
1551/**
Ronald Cronab65c522021-11-24 10:47:20 +01001552 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1553 *
1554 * Enable TLS 1.3 middlebox compatibility mode.
1555 *
1556 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1557 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1558 * expecting TLS 1.2 traffic.
1559 *
1560 * Turning on the compatibility mode comes at the cost of a few added bytes
1561 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1562 * that don't use it. Therefore, unless transmission bandwidth is critical and
1563 * you know that middlebox compatibility issues won't occur, it is therefore
1564 * recommended to set this option.
1565 *
1566 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001567 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1568 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001569 *
1570 */
1571//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1572
1573/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001574 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1575 *
1576 * Enable TLS 1.3 PSK key exchange mode.
1577 *
1578 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1579 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1580 * effect on the build.
1581 *
1582 */
1583#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1584
1585/**
1586 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1587 *
1588 * Enable TLS 1.3 ephemeral key exchange mode.
1589 *
1590 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1591 * MBEDTLS_PKCS1_V21
1592 *
1593 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1594 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1595 * effect on the build.
1596 *
1597 */
1598#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1599
1600/**
1601 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1602 *
1603 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1604 *
1605 * Requires: MBEDTLS_ECDH_C
1606 *
1607 * Comment to disable support for the PSK ephemeral key exchange mode in
1608 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1609 * have any effect on the build.
1610 *
1611 */
1612#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1613
1614/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001615 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001616 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001617 * Maximum time difference in milliseconds tolerated between the age of a
1618 * ticket from the server and client point of view.
1619 * From the client point of view, the age of a ticket is the time difference
1620 * between the time when the client proposes to the server to use the ticket
1621 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1622 * the time the client received the ticket from the server.
1623 * From the server point of view, the age of a ticket is the time difference
1624 * between the time when the server receives a proposition from the client
1625 * to use the ticket and the time when the ticket was created by the server.
1626 * The server age is expected to be always greater than the client one and
1627 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1628 * maximum difference tolerated for the server to accept the ticket.
1629 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001630 *
1631 */
1632#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1633
1634/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001635 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1636 *
1637 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1638 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001639 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001640 */
Jerry Yu9750f812022-07-20 11:04:50 +08001641#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001642
1643/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001644 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1645 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001646 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1647 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1648 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001649 *
1650 */
1651#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1652
1653/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001654* \def MBEDTLS_SSL_EARLY_DATA
1655*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001656* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001657*
Xiaokang Qian65fc0de2022-10-25 09:08:57 +00001658* Requires: MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1659* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001660*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001661* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1662* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001663*
1664* This feature is experimental, not completed and thus not ready for
1665* production.
1666*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001667*/
1668//#define MBEDTLS_SSL_EARLY_DATA
1669
1670/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001672 *
1673 * Enable support for DTLS (all available versions).
1674 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001675 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001676 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001677 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001678 *
1679 * Comment this macro to disable support for DTLS
1680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001682
1683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001685 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001686 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001687 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001688 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001689 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001691
1692/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001693 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001694 *
1695 * Enable support for the anti-replay mechanism in DTLS.
1696 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 * Requires: MBEDTLS_SSL_TLS_C
1698 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001699 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001700 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001701 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001702 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001703 * Comment this to disable anti-replay in DTLS.
1704 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001706
1707/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001709 *
1710 * Enable support for HelloVerifyRequest on DTLS servers.
1711 *
1712 * This feature is highly recommended to prevent DTLS servers being used as
1713 * amplifiers in DoS attacks against other hosts. It should always be enabled
1714 * unless you know for sure amplification cannot be a problem in the
1715 * environment in which your server operates.
1716 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001717 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001718 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001719 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001720 *
1721 * Comment this to disable support for HelloVerifyRequest.
1722 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001724
1725/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001726 * \def MBEDTLS_SSL_DTLS_SRTP
1727 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001728 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001729 * through the use_srtp extension.
1730 *
1731 * \note This feature provides the minimum functionality required
1732 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1733 * the associated SRTP packet protection key material.
1734 * In particular, the SRTP packet protection itself, as well as the
1735 * demultiplexing of RTP and DTLS packets at the datagram layer
1736 * (see Section 5 of RFC 5764), are not handled by this feature.
1737 * Instead, after successful completion of a handshake negotiating
1738 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001739 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001740 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1741 * (this is implemented in the SSL example programs).
1742 * The resulting key should then be passed to an SRTP stack.
1743 *
1744 * Setting this option enables the runtime API
1745 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1746 * through which the supported DTLS-SRTP protection
1747 * profiles can be configured. You must call this API at
1748 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001749 *
1750 * Requires: MBEDTLS_SSL_PROTO_DTLS
1751 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001752 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001753 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001754//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001755
1756/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001757 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1758 *
1759 * Enable server-side support for clients that reconnect from the same port.
1760 *
1761 * Some clients unexpectedly close the connection and try to reconnect using the
1762 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001763 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001764 * flag enables that support.
1765 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001766 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001767 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001768 * Comment this to disable support for clients reusing the source port.
1769 */
1770#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1771
1772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001774 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001775 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001776 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001777 * session store remains the responsibility of the application, though).
1778 * Server-side, you also need to provide callbacks for writing and parsing
1779 * tickets, including authenticated encryption and key management. Example
1780 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001781 *
1782 * Comment this macro to disable support for SSL session tickets
1783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001784#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001785
1786/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001788 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001789 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001790 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001792 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001793 * Comment this macro to disable support for server name indication in SSL
1794 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001795#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001796
1797/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001798 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1799 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001800 * When this option is enabled, the SSL buffer will be resized automatically
1801 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001802 *
1803 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001804 */
1805//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1806
1807/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001808 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1809 *
1810 * Enable testing of the constant-flow nature of some sensitive functions with
1811 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001812 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001813 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001814 * This setting requires compiling with clang -fsanitize=memory. The test
1815 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001816 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001817 * \warning This macro is only used for extended testing; it is not considered
1818 * part of the library's API, so it may change or disappear at any time.
1819 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001820 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001821 */
1822//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1823
1824/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001825 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1826 *
1827 * Enable testing of the constant-flow nature of some sensitive functions with
1828 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001829 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001830 *
1831 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001832 * testing if the tests suites are run with valgrind's memcheck. This can be
1833 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1834 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001835 *
1836 * \warning This macro is only used for extended testing; it is not considered
1837 * part of the library's API, so it may change or disappear at any time.
1838 *
1839 * Uncomment to enable testing of the constant-flow nature of selected code.
1840 */
1841//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1842
1843/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001844 * \def MBEDTLS_TEST_HOOKS
1845 *
1846 * Enable features for invasive testing such as introspection functions and
1847 * hooks for fault injection. This enables additional unit tests.
1848 *
1849 * Merely enabling this feature should not change the behavior of the product.
1850 * It only adds new code, and new branching points where the default behavior
1851 * is the same as when this feature is disabled.
1852 * However, this feature increases the attack surface: there is an added
1853 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1854 * Therefore this feature must never be enabled in production.
1855 *
1856 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1857 * information.
1858 *
1859 * Uncomment to enable invasive tests.
1860 */
1861//#define MBEDTLS_TEST_HOOKS
1862
1863/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001864 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001865 *
1866 * Provide your own alternate threading implementation.
1867 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001868 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001869 *
1870 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001871 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001873
1874/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001875 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001876 *
1877 * Enable the pthread wrapper layer for the threading layer.
1878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001879 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001880 *
1881 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001883//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001884
1885/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001886 * \def MBEDTLS_USE_PSA_CRYPTO
1887 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001888 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1889 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001890 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001891 * \note Development of this option is currently in progress, and parts of Mbed
1892 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001893 * will still continue to work as usual, so enabling this option should not
1894 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001895 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001896 * \note See docs/use-psa-crypto.md for a complete description of what this
1897 * option currently does, and of parts that are not affected by it so far.
1898 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001899 * \warning If you enable this option, you need to call `psa_crypto_init()`
1900 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001901 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001902 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001903 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001904 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001905 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001906 */
1907//#define MBEDTLS_USE_PSA_CRYPTO
1908
1909/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001910 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1911 *
John Durkop185764f2020-10-12 21:32:12 -07001912 * This setting allows support for cryptographic mechanisms through the PSA
1913 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001914 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001915 * When this option is disabled, the PSA API exposes the cryptographic
1916 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1917 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001918 *
1919 * When this option is enabled, the PSA API exposes the cryptographic
1920 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1921 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1922 * automatically enabled if required (i.e. if no PSA driver provides the
1923 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1924 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001925 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001926 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001927 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001928 *
John Durkop185764f2020-10-12 21:32:12 -07001929 * This feature is still experimental and is not ready for production since
1930 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001931 */
1932//#define MBEDTLS_PSA_CRYPTO_CONFIG
1933
1934/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001936 *
1937 * Allow run-time checking of compile-time enabled features. Thus allowing users
1938 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001940 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001942 *
1943 * Comment this to disable run-time checking and save ROM space
1944 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001946
1947/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001948 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1949 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001950 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001951 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1952 * the set of trusted certificates through a callback instead of a linked
1953 * list.
1954 *
1955 * This is useful for example in environments where a large number of trusted
1956 * certificates is present and storing them in a linked list isn't efficient
1957 * enough, or when the set of trusted certificates changes frequently.
1958 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001959 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001960 * `mbedtls_ssl_conf_ca_cb()` for more information.
1961 *
1962 * Uncomment to enable trusted certificate callbacks.
1963 */
1964//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1965
1966/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001967 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001968 *
Chris Jones2c745862020-12-16 11:41:06 +00001969 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001970 *
Chris Jones2c745862020-12-16 11:41:06 +00001971 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001972 * and other functions/constants only used by these functions, thus reducing
1973 * the code footprint by several KB.
1974 */
Chris Jones2c745862020-12-16 11:41:06 +00001975//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001976
1977/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001979 *
1980 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1981 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1982 *
1983 * Comment this macro to disallow using RSASSA-PSS in certificates.
1984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01001986/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001987
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001988/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001989 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001990 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001991 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001992 * \{
1993 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001994
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001997 *
1998 * Enable AES-NI support on x86-64.
1999 *
2000 * Module: library/aesni.c
2001 * Caller: library/aes.c
2002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002004 *
2005 * This modules adds support for the AES-NI instructions on x86-64
2006 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002008
2009/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002010 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002011 *
2012 * Enable the AES block cipher.
2013 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002014 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002015 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002016 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002017 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002018 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002019 * This module enables the following ciphersuites (if other requisites are
2020 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002021 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2022 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2023 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2024 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2025 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2026 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2027 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2028 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2029 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2030 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2031 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2032 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2033 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2034 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2035 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2036 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2037 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2038 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2039 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2040 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2041 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2042 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2043 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2044 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2045 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2046 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2047 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2048 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2049 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2050 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2051 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2052 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2053 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2054 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2055 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2056 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2057 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2058 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2059 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2060 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2061 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2062 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2063 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2064 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2065 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2066 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2067 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2068 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2069 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2070 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2071 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2072 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2073 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2074 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2075 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2076 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2077 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2078 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002079 *
Paul Bakkercff68422013-09-15 20:43:33 +02002080 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002081 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002083
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002084/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002085 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002086 *
2087 * Enable the generic ASN1 parser.
2088 *
2089 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002090 * Caller: library/x509.c
2091 * library/dhm.c
2092 * library/pkcs12.c
2093 * library/pkcs5.c
2094 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002095 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002096#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002097
2098/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002099 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002100 *
2101 * Enable the generic ASN1 writer.
2102 *
2103 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002104 * Caller: library/ecdsa.c
2105 * library/pkwrite.c
2106 * library/x509_create.c
2107 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002108 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002110#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002111
2112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002114 *
2115 * Enable the Base64 module.
2116 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002117 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002118 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002119 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002120 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002122#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002124/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002126 *
Paul Bakker9a736322012-11-14 12:39:52 +00002127 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002128 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002129 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002130 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002131 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002132 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002133 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002134 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002135 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002136 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002137 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002138 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002139 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002140 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002143
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002144/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002146 *
2147 * Enable the Camellia block cipher.
2148 *
Paul Bakker38119b12009-01-10 23:31:23 +00002149 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002150 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002151 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002152 * This module enables the following ciphersuites (if other requisites are
2153 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2155 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2156 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2157 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2158 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2159 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2160 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2161 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2162 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2163 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2164 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2165 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2166 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2167 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2168 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2169 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2170 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2171 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2172 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2173 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2174 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2175 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2176 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2177 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2178 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2179 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2180 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2181 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2182 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2183 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2184 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2185 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2186 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2187 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2188 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2189 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2190 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2191 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2192 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2193 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2194 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2195 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002197#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002198
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002199/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002200 * \def MBEDTLS_ARIA_C
2201 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002202 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002203 *
2204 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002205 * Caller: library/cipher.c
2206 *
2207 * This module enables the following ciphersuites (if other requisites are
2208 * enabled as well):
2209 *
2210 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2211 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2212 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2213 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2214 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2215 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2216 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2217 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2218 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2219 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2220 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2222 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2223 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2224 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2225 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2226 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2227 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2228 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2229 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2230 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2231 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2232 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2233 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2234 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2235 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2236 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2237 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2238 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2239 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2240 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2241 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2242 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2243 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2244 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2245 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2246 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002248 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002249#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002250
2251/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002253 *
2254 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2255 *
2256 * Module: library/ccm.c
2257 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002258 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2259 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002260 *
2261 * This module enables the AES-CCM ciphersuites, if other requisites are
2262 * enabled as well.
2263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002265
2266/**
Daniel King34b822c2016-05-15 17:28:08 -03002267 * \def MBEDTLS_CHACHA20_C
2268 *
2269 * Enable the ChaCha20 stream cipher.
2270 *
2271 * Module: library/chacha20.c
2272 */
2273#define MBEDTLS_CHACHA20_C
2274
2275/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002276 * \def MBEDTLS_CHACHAPOLY_C
2277 *
2278 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2279 *
2280 * Module: library/chachapoly.c
2281 *
2282 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2283 */
2284#define MBEDTLS_CHACHAPOLY_C
2285
2286/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002287 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002288 *
2289 * Enable the generic cipher layer.
2290 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002291 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002292 * Caller: library/ccm.c
2293 * library/cmac.c
2294 * library/gcm.c
2295 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002296 * library/pkcs12.c
2297 * library/pkcs5.c
2298 * library/psa_crypto_aead.c
2299 * library/psa_crypto_mac.c
2300 * library/ssl_ciphersuites.c
2301 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002302 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002303 *
2304 * Uncomment to enable generic cipher wrappers.
2305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002307
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002308/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002309 * \def MBEDTLS_CMAC_C
2310 *
Simon Butcher327398a2016-10-05 14:09:11 +01002311 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2312 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002313 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002314 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2315 * implementation of the CMAC algorithm is provided by an alternate
2316 * implementation, that alternate implementation may opt to not support
2317 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2318 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002319 * Module: library/cmac.c
2320 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002321 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002322 *
2323 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002324#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002325
2326/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002327 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002328 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002329 * Enable the CTR_DRBG AES-based random generator.
2330 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002331 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002332 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002333 * \note To achieve a 256-bit security strength with CTR_DRBG,
2334 * you must use AES-256 *and* use sufficient entropy.
2335 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002336 *
2337 * Module: library/ctr_drbg.c
2338 * Caller:
2339 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002341 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002342 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002345
2346/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002348 *
2349 * Enable the debug functions.
2350 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002351 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002352 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002353 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002354 * library/ssl_tls12_*.c
2355 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002356 *
2357 * This module provides debugging functions.
2358 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002360
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002361/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002362 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002363 *
2364 * Enable the DES block cipher.
2365 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002366 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002367 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002368 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002369 *
Paul Bakkercff68422013-09-15 20:43:33 +02002370 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002371 *
2372 * \warning DES is considered a weak cipher and its use constitutes a
2373 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002376
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002377/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002379 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002380 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002381 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002382 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002383 * Caller: library/ssl_tls.c
2384 * library/ssl*_client.c
2385 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002387 * This module is used by the following key exchanges:
2388 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002389 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002390 * \warning Using DHE constitutes a security risk as it
2391 * is not possible to validate custom DH parameters.
2392 * If possible, it is recommended users should consider
2393 * preferring other methods of key exchange.
2394 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002395 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002397#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002398
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002401 *
2402 * Enable the elliptic curve Diffie-Hellman library.
2403 *
2404 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002405 * Caller: library/psa_crypto.c
2406 * library/ssl_tls.c
2407 * library/ssl*_client.c
2408 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002409 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002410 * This module is used by the following key exchanges:
2411 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002412 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002413 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002414 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002416
2417/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002419 *
2420 * Enable the elliptic curve DSA library.
2421 *
2422 * Module: library/ecdsa.c
2423 * Caller:
2424 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002425 * This module is used by the following key exchanges:
2426 * ECDHE-ECDSA
2427 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002428 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2429 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2430 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002433
2434/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002435 * \def MBEDTLS_ECJPAKE_C
2436 *
2437 * Enable the elliptic curve J-PAKE library.
2438 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002439 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2440 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002441 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002442 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002443 * Module: library/ecjpake.c
2444 * Caller:
2445 *
2446 * This module is used by the following key exchanges:
2447 * ECJPAKE
2448 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002449 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002450 *
2451 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2452 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002453 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002454#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002455
2456/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002457 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002458 *
2459 * Enable the elliptic curve over GF(p) library.
2460 *
2461 * Module: library/ecp.c
2462 * Caller: library/ecdh.c
2463 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002464 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002465 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002469
2470/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002472 *
2473 * Enable the platform-specific entropy code.
2474 *
2475 * Module: library/entropy.c
2476 * Caller:
2477 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002479 *
2480 * This module provides a generic entropy pool
2481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002482#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002483
2484/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002485 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002486 *
2487 * Enable error code to error string conversion.
2488 *
2489 * Module: library/error.c
2490 * Caller:
2491 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002492 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002493 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002494#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002495
2496/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002498 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002499 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002500 *
2501 * Module: library/gcm.c
2502 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002503 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2504 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002505 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002506 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2507 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002509#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002510
2511/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002512 * \def MBEDTLS_HKDF_C
2513 *
2514 * Enable the HKDF algorithm (RFC 5869).
2515 *
2516 * Module: library/hkdf.c
2517 * Caller:
2518 *
2519 * Requires: MBEDTLS_MD_C
2520 *
2521 * This module adds support for the Hashed Message Authentication Code
2522 * (HMAC)-based key derivation function (HKDF).
2523 */
2524#define MBEDTLS_HKDF_C
2525
2526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002528 *
2529 * Enable the HMAC_DRBG random generator.
2530 *
2531 * Module: library/hmac_drbg.c
2532 * Caller:
2533 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002535 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002536 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002537 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002538#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002539
2540/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002541 * \def MBEDTLS_LMS_C
2542 *
2543 * Enable the LMS stateful-hash asymmetric signature algorithm.
2544 *
2545 * Module: library/lms.c
2546 * Caller:
2547 *
Raef Colesab4f8742022-09-01 12:24:31 +01002548 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002549 *
Raef Colesab4f8742022-09-01 12:24:31 +01002550 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002551 */
2552#define MBEDTLS_LMS_C
2553
2554/**
Raef Colesab4f8742022-09-01 12:24:31 +01002555 * \def MBEDTLS_LMS_PRIVATE
2556 *
2557 * Enable LMS private-key operations and signing code. Functions enabled by this
2558 * option are experimental, and should not be used in production.
2559 *
2560 * Requires: MBEDTLS_LMS_C
2561 *
2562 * Uncomment to enable the LMS signature algorithm and private key operations.
2563 */
Raef Coles5127e852022-10-07 10:35:56 +01002564//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002565
2566/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002567 * \def MBEDTLS_NIST_KW_C
2568 *
2569 * Enable the Key Wrapping mode for 128-bit block ciphers,
2570 * as defined in NIST SP 800-38F. Only KW and KWP modes
2571 * are supported. At the moment, only AES is approved by NIST.
2572 *
2573 * Module: library/nist_kw.c
2574 *
2575 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2576 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002577#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002578
2579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002581 *
2582 * Enable the generic message digest layer.
2583 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002584 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2585 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2586 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002587 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002588 * Caller: library/constant_time.c
2589 * library/ecdsa.c
2590 * library/ecjpake.c
2591 * library/hkdf.c
2592 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002593 * library/pk.c
2594 * library/pkcs5.c
2595 * library/pkcs12.c
2596 * library/psa_crypto_ecp.c
2597 * library/psa_crypto_rsa.c
2598 * library/rsa.c
2599 * library/ssl_cookie.c
2600 * library/ssl_msg.c
2601 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002602 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002603 * library/x509_crt.c
2604 * library/x509write_crt.c
2605 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002606 *
2607 * Uncomment to enable generic message digest wrappers.
2608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002610
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002613 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002614 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002615 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002616 * Module: library/md5.c
2617 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002618 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002619 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002620 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002621 * This module is required for TLS 1.2 depending on the handshake parameters.
2622 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2623 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002624 *
2625 * \warning MD5 is considered a weak message digest and its use constitutes a
2626 * security risk. If possible, we recommend avoiding dependencies on
2627 * it, and considering stronger message digests instead.
2628 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002631
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002632/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002633 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002634 *
2635 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002636 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002637 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002638 *
2639 * Module: library/memory_buffer_alloc.c
2640 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * Requires: MBEDTLS_PLATFORM_C
2642 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002643 *
2644 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002647
2648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002650 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002651 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2652 *
Simon Butcherd567a232016-03-09 20:19:21 +00002653 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2654 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002655 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002656 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002657 * \note See also our Knowledge Base article about porting to a new
2658 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002659 * 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 +00002660 *
Andres AG788aa4a2016-09-14 14:32:09 +01002661 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002662 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002663 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002666
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002669 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002670 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002671 *
2672 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002673 * Caller: library/asn1write.c
2674 * library/pkcs5.c
2675 * library/pkparse.c
2676 * library/pkwrite.c
2677 * library/rsa.c
2678 * library/x509.c
2679 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002680 * library/x509_crl.c
2681 * library/x509_crt.c
2682 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002683 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002684 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002685 *
2686 * This modules translates between OIDs and internal values.
2687 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002689
2690/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002691 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002692 *
2693 * Enable VIA Padlock support on x86.
2694 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002695 * Module: library/padlock.c
2696 * Caller: library/aes.c
2697 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002698 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002699 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002700 * This modules adds support for the VIA PadLock on x86.
2701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002703
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002704/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002705 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002706 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002707 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002708 *
2709 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002710 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002711 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002712 * library/x509_crl.c
2713 * library/x509_crt.c
2714 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002715 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002717 *
Paul Bakkercff68422013-09-15 20:43:33 +02002718 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002720#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002721
2722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002723 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002724 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002725 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002726 *
2727 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002728 * Caller: library/pkwrite.c
2729 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002730 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002733 *
2734 * This modules adds support for encoding / writing PEM files.
2735 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002737
2738/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002739 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002740 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002741 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002742 *
2743 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002744 * Caller: library/psa_crypto_rsa.c
2745 * library/ssl_tls.c
2746 * library/ssl*_client.c
2747 * library/ssl*_server.c
2748 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002749 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002750 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002751 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002752 * Uncomment to enable generic public key wrappers.
2753 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002754#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002755
2756/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002758 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002759 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002760 *
2761 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002762 * Caller: library/x509_crt.c
2763 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002764 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002765 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002766 *
2767 * Uncomment to enable generic public key parse functions.
2768 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002770
2771/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002773 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002774 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002775 *
2776 * Module: library/pkwrite.c
2777 * Caller: library/x509write.c
2778 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002779 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002780 *
2781 * Uncomment to enable generic public key write functions.
2782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002783#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002784
2785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002787 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002788 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002789 *
2790 * Module: library/pkcs5.c
2791 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002792 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2793 *
2794 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2795 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002796 *
2797 * This module adds support for the PKCS#5 functions.
2798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002800
2801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002803 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002804 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002805 * Adds algorithms for parsing PKCS#8 encrypted private keys
2806 *
2807 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002808 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002809 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002810 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2811 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2812 *
2813 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2814 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002815 *
2816 * This module enables PKCS#12 functions.
2817 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002819
2820/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002821 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002822 *
2823 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002824 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2827 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002828 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002829 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002830 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002831 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002832 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002833 * Module: library/platform.c
2834 * Caller: Most other .c files
2835 *
2836 * This module enables abstraction of common (libc) functions.
2837 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002838#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002839
2840/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002841 * \def MBEDTLS_POLY1305_C
2842 *
2843 * Enable the Poly1305 MAC algorithm.
2844 *
2845 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002846 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002847 */
2848#define MBEDTLS_POLY1305_C
2849
2850/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002851 * \def MBEDTLS_PSA_CRYPTO_C
2852 *
2853 * Enable the Platform Security Architecture cryptography API.
2854 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002855 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002856 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002857 * Requires: MBEDTLS_CIPHER_C,
2858 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002859 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002860 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002861 *
2862 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002863#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002864
2865/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002866 * \def MBEDTLS_PSA_CRYPTO_SE_C
2867 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002868 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002869 * cryptography API.
2870 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002871 * \deprecated This feature is deprecated. Please switch to the driver
2872 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002873 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002874 * Module: library/psa_crypto_se.c
2875 *
2876 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2877 *
2878 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002879//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002880
2881/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002882 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2883 *
2884 * Enable the Platform Security Architecture persistent key storage.
2885 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002886 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002887 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002888 * Requires: MBEDTLS_PSA_CRYPTO_C,
2889 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2890 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002891 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002892#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002893
2894/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002895 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002896 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002897 * Enable the emulation of the Platform Security Architecture
2898 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002899 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002900 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002901 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002902 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002903 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002904#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002905
2906/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002907 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002908 *
2909 * Enable the RIPEMD-160 hash algorithm.
2910 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002911 * Module: library/ripemd160.c
2912 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002913 *
2914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002916
2917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002919 *
2920 * Enable the RSA public-key cryptosystem.
2921 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002922 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002923 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002924 * Caller: library/pk.c
2925 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002926 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002927 * library/ssl*_client.c
2928 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002929 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002930 * This module is used by the following key exchanges:
2931 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002932 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002933 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002935#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002936
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002937/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002939 *
2940 * Enable the SHA1 cryptographic hash algorithm.
2941 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002942 * Module: library/sha1.c
2943 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002944 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002945 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002946 * This module is required for TLS 1.2 depending on the handshake parameters,
2947 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002948 *
2949 * \warning SHA-1 is considered a weak message digest and its use constitutes
2950 * a security risk. If possible, we recommend avoiding dependencies
2951 * on it, and considering stronger message digests instead.
2952 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002955
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002956/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002957 * \def MBEDTLS_SHA224_C
2958 *
2959 * Enable the SHA-224 cryptographic hash algorithm.
2960 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002961 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02002962 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002963 *
2964 * Module: library/sha256.c
2965 * Caller: library/md.c
2966 * library/ssl_cookie.c
2967 *
2968 * This module adds support for SHA-224.
2969 */
2970#define MBEDTLS_SHA224_C
2971
2972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002974 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002975 * Enable the SHA-256 cryptographic hash algorithm.
2976 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002977 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002978 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002979 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002980 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002981 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002982 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002983 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002984 * library/ssl*_client.c
2985 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002986 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002987 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002988 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002989 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002991
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002992/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002993 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2994 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002995 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2996 * with the ARMv8 cryptographic extensions if they are available at runtime.
2997 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002998 *
2999 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3000 * for a non-Aarch64 build it will be silently ignored.
3001 *
3002 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3003 * of \c -march=armv8-a+crypto.
3004 *
3005 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3006 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3007 *
3008 * Requires: MBEDTLS_SHA256_C.
3009 *
3010 * Module: library/sha256.c
3011 *
3012 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3013 * and use them if available.
3014 */
3015//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3016
3017/**
3018 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3019 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003020 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3021 * with the ARMv8 cryptographic extensions, which must be available at runtime
3022 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003023 *
3024 * \note This allows builds with a smaller code size than with
3025 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3026 *
3027 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3028 * of \c -march=armv8-a+crypto.
3029 *
3030 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3031 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3032 *
3033 * Requires: MBEDTLS_SHA256_C.
3034 *
3035 * Module: library/sha256.c
3036 *
3037 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3038 * unconditionally.
3039 */
3040//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3041
3042/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003043 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003044 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003045 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003046 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003047 * Requires: MBEDTLS_SHA512_C
3048 *
3049 * Module: library/sha512.c
3050 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003051 * library/psa_crypto_hash.c
3052 * library/ssl_tls.c
3053 * library/ssl*_client.c
3054 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003055 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003056 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003057 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003058#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003059
3060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003062 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003063 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003064 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003065 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003066 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003067 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003068 * library/ssl_tls.c
3069 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003070 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003071 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003072 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003074
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003075/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003076 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3077 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003078 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3079 * with the ARMv8 cryptographic extensions if they are available at runtime.
3080 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003081 *
3082 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3083 * for a non-Aarch64 build it will be silently ignored.
3084 *
3085 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3086 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3087 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3088 * fastest code.
3089 *
3090 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3091 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3092 *
3093 * Requires: MBEDTLS_SHA512_C.
3094 *
3095 * Module: library/sha512.c
3096 *
3097 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3098 * and use them if available.
3099 */
3100//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3101
3102/**
3103 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3104 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003105 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3106 * with the ARMv8 cryptographic extensions, which must be available at runtime
3107 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003108 *
3109 * \note This allows builds with a smaller code size than with
3110 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3111 *
3112 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3113 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3114 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3115 * fastest code.
3116 *
3117 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3118 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3119 *
3120 * Requires: MBEDTLS_SHA512_C.
3121 *
3122 * Module: library/sha512.c
3123 *
3124 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3125 * unconditionally.
3126 */
3127//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3128
3129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003131 *
3132 * Enable simple SSL cache implementation.
3133 *
3134 * Module: library/ssl_cache.c
3135 * Caller:
3136 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003137 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003139#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003140
3141/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003143 *
3144 * Enable basic implementation of DTLS cookies for hello verification.
3145 *
3146 * Module: library/ssl_cookie.c
3147 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003148 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003150
3151/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003152 * \def MBEDTLS_SSL_TICKET_C
3153 *
3154 * Enable an implementation of TLS server-side callbacks for session tickets.
3155 *
3156 * Module: library/ssl_ticket.c
3157 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003158 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003159 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3160 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003161 */
3162#define MBEDTLS_SSL_TICKET_C
3163
3164/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003166 *
3167 * Enable the SSL/TLS client code.
3168 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003169 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003170 * Caller:
3171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003174 * This module is required for SSL/TLS client support.
3175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003176#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003177
Paul Bakker9a736322012-11-14 12:39:52 +00003178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003180 *
3181 * Enable the SSL/TLS server code.
3182 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003183 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003184 * Caller:
3185 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003186 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003187 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003188 * This module is required for SSL/TLS server support.
3189 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003191
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003192/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003194 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003195 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003196 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003197 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003198 * Caller: library/ssl*_client.c
3199 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003201 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3202 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003203 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003204 * This module is required for SSL/TLS.
3205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003207
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003208/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003210 *
3211 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003212 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003213 * contexts are not shared between threads. If you do intend to use contexts
3214 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003215 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003216 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003217 *
3218 * Module: library/threading.c
3219 *
3220 * This allows different threading implementations (self-implemented or
3221 * provided).
3222 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223 * You will have to enable either MBEDTLS_THREADING_ALT or
3224 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003225 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003226 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003229
3230/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003232 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003233 * Enable the semi-portable timing interface.
3234 *
Simon Butcherd567a232016-03-09 20:19:21 +00003235 * \note The provided implementation only works on POSIX/Unix (including Linux,
3236 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003237 * module and provide your own implementations of the callbacks needed by
3238 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3239 * your own implementation of the whole module by setting
3240 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003241 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003242 * \note The timing module will include time.h on suitable platforms
3243 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3244 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3245 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003246 * \note See also our Knowledge Base article about porting to a new
3247 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003248 * 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 +00003249 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003250 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003251 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003253
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003254/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003256 *
3257 * Enable run-time version information.
3258 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003259 * Module: library/version.c
3260 *
3261 * This module provides run-time version information.
3262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003263#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003264
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003265/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003266 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003267 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003268 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003269 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003270 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003271 * Caller: library/x509_crl.c
3272 * library/x509_crt.c
3273 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003274 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003275 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003276 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3277 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003278 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3279 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003280 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003281 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003283#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003284
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003286 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003287 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003288 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003289 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003290 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003291 * Caller: library/ssl_tls.c
3292 * library/ssl*_client.c
3293 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003294 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003296 *
3297 * This module is required for X.509 certificate parsing.
3298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003300
3301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003303 *
3304 * Enable X.509 CRL parsing.
3305 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003306 * Module: library/x509_crl.c
3307 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003308 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003310 *
3311 * This module is required for X.509 CRL parsing.
3312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003314
3315/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003316 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003317 *
3318 * Enable X.509 Certificate Signing Request (CSR) parsing.
3319 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003320 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003321 * Caller: library/x509_crt_write.c
3322 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003324 *
3325 * This module is used for reading X.509 certificate request.
3326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003327#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003328
3329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003331 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003332 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003333 *
3334 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003335 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003336 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003337 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3338 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003339 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3340 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003341 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003342 * This module is the basis for creating X.509 certificates and CSRs.
3343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003345
3346/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003347 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003348 *
3349 * Enable creating X.509 certificates.
3350 *
3351 * Module: library/x509_crt_write.c
3352 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003354 *
3355 * This module is required for X.509 certificate creation.
3356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003358
3359/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003361 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003362 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003363 *
3364 * Module: library/x509_csr_write.c
3365 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003367 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003368 * This module is required for X.509 certificate request writing.
3369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003371
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003372/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003373
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003374/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003375 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003376 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003377 * This section contains Mbed TLS build settings that are not associated
3378 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003379 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003380 * \{
3381 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003382
Gilles Peskinea02c1242022-03-16 17:03:19 +01003383/**
3384 * \def MBEDTLS_CONFIG_FILE
3385 *
3386 * If defined, this is a header which will be included instead of
3387 * `"mbedtls/mbedtls_config.h"`.
3388 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003389 * Unlike other configuration options, this one must be defined on the
3390 * compiler command line: a definition in `mbedtls_config.h` would have
3391 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003392 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003393 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003394 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003395 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003396 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003397 * The value of this symbol is typically a path in double quotes, either
3398 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003399 */
3400//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3401
3402/**
3403 * \def MBEDTLS_USER_CONFIG_FILE
3404 *
3405 * If defined, this is a header which will be included after
3406 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003407 * This allows you to modify the default configuration, including the ability
3408 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003409 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003410 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003411 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003412 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003413 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003414 * The value of this symbol is typically a path in double quotes, either
3415 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003416 */
3417//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3418
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003419/**
3420 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3421 *
3422 * If defined, this is a header which will be included instead of
3423 * `"psa/crypto_config.h"`.
3424 * This header file specifies which cryptographic mechanisms are available
3425 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3426 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3427 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003428 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003429 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003430 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003431 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003432 * The value of this symbol is typically a path in double quotes, either
3433 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003434 */
3435//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3436
3437/**
3438 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3439 *
3440 * If defined, this is a header which will be included after
3441 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003442 * This allows you to modify the default configuration, including the ability
3443 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003444 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003445 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003446 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003447 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003448 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003449 * The value of this symbol is typically a path in double quotes, either
3450 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003451 */
3452//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3453
Gilles Peskineba4162a2022-04-11 17:04:38 +02003454/** \} name SECTION: General configuration options */
3455
3456/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003457 * \name SECTION: Module configuration options
3458 *
3459 * This section allows for the setting of module specific sizes and
3460 * configuration options. The default values are already present in the
3461 * relevant header files and should suffice for the regular use cases.
3462 *
3463 * Our advice is to enable options and change their values here
3464 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003465 * \{
3466 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003467/* The Doxygen documentation here is used when a user comments out a
3468 * setting and runs doxygen themselves. On the other hand, when we typeset
3469 * the full documentation including disabled settings, the documentation
3470 * in specific modules' header files is used if present. When editing this
3471 * file, make sure that each option is documented in exactly one place,
3472 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3473 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003474
Paul Bakker088c5c52014-04-25 11:11:10 +02003475/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003476//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003477//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003478
Paul Bakker088c5c52014-04-25 11:11:10 +02003479/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3481//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3482//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3483//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3484//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003485
Paul Bakker088c5c52014-04-25 11:11:10 +02003486/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3488//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3489//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3490//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003491
Paul Bakker088c5c52014-04-25 11:11:10 +02003492/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003493//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003495
Paul Bakker088c5c52014-04-25 11:11:10 +02003496/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3498//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003499//#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 +01003500
Paul Bakker088c5c52014-04-25 11:11:10 +02003501/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003502//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003503
Paul Bakker088c5c52014-04-25 11:11:10 +02003504/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505//#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 +02003506//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003508//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003510//#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 +02003511//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3512//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003513/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003515//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3516//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003517//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3518//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3519//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003520
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3522/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003523//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3525//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003526//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003527//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3528//#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 +02003529//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3530//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003531/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003533//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003534//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3535//#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 +02003536
Gilles Peskine3f106f72021-09-23 17:42:39 +02003537/** \def MBEDTLS_CHECK_RETURN
3538 *
3539 * This macro is used at the beginning of the declaration of a function
3540 * to indicate that its return value should be checked. It should
3541 * instruct the compiler to emit a warning or an error if the function
3542 * is called without checking its return value.
3543 *
3544 * There is a default implementation for popular compilers in platform_util.h.
3545 * You can override the default implementation by defining your own here.
3546 *
3547 * If the implementation here is empty, this will effectively disable the
3548 * checking of functions' return values.
3549 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003550//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003551
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003552/** \def MBEDTLS_IGNORE_RETURN
3553 *
3554 * This macro requires one argument, which should be a C function call.
3555 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3556 * warning is suppressed.
3557 */
3558//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3559
Gilles Peskineed038902020-11-13 21:33:21 +01003560/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003561/**
Gilles Peskineed038902020-11-13 21:33:21 +01003562 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3563 * PSA crypto subsystem.
3564 *
3565 * If this option is unset:
3566 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003567 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003568 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3569 * on unspecified heuristics.
3570 */
3571//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3572
Steven Cooreman863470a2021-02-15 14:03:19 +01003573/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003574 * Restrict the PSA library to supporting a maximum amount of simultaneously
3575 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3576 * volatile key, or a persistent key which is loaded temporarily by the
3577 * library as part of a crypto operation in flight.
3578 *
3579 * If this option is unset, the library will fall back to a default value of
3580 * 32 keys.
3581 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003582//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003583
Paul Bakker088c5c52014-04-25 11:11:10 +02003584/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003585//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3586//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003587
Paul Bakker088c5c52014-04-25 11:11:10 +02003588/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003589
Angus Grattond8213d02016-05-25 20:56:48 +10003590/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3591 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003592 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003593 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003594 * This determines the size of the incoming TLS I/O buffer in such a way
3595 * that it is capable of holding the specified amount of plaintext data,
3596 * regardless of the protection mechanism used.
3597 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003598 * \note When using a value less than the default of 16KB on the client, it is
3599 * recommended to use the Maximum Fragment Length (MFL) extension to
3600 * inform the server about this limitation. On the server, there
3601 * is no supported, standardized way of informing the client about
3602 * restriction on the maximum size of incoming messages, and unless
3603 * the limitation has been communicated by other means, it is recommended
3604 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3605 * while keeping the default value of 16KB for the incoming buffer.
3606 *
David Horstmann95d516f2021-05-04 18:36:56 +01003607 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003608 */
3609//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3610
Gilles Peskined3d02902020-03-04 21:35:27 +01003611/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3612 *
3613 * The maximum length of CIDs used for incoming DTLS messages.
3614 *
3615 */
3616//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3617
3618/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3619 *
3620 * The maximum length of CIDs used for outgoing DTLS messages.
3621 *
3622 */
3623//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3624
TRodziewicze8dd7092021-05-12 14:19:11 +02003625/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003626 *
3627 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003628 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003629 *
3630 * The padding will always be chosen so that the length of the
3631 * padded plaintext is a multiple of the value of this option.
3632 *
3633 * Note: A value of \c 1 means that no padding will be used
3634 * for outgoing records.
3635 *
3636 * Note: On systems lacking division instructions,
3637 * a power of two should be preferred.
3638 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003639//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003640
Angus Grattond8213d02016-05-25 20:56:48 +10003641/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3642 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003643 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003644 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003645 * This determines the size of the outgoing TLS I/O buffer in such a way
3646 * that it is capable of holding the specified amount of plaintext data,
3647 * regardless of the protection mechanism used.
3648 *
Angus Grattond8213d02016-05-25 20:56:48 +10003649 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3650 * the default inward 16384 byte buffer to conform to the TLS specification.
3651 *
3652 * The minimum required outward buffer size is determined by the handshake
3653 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3654 * The specific size requirement depends on the configured ciphers and any
3655 * certificate data which is sent during the handshake.
3656 *
David Horstmann95d516f2021-05-04 18:36:56 +01003657 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003658 */
3659//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3660
Hanno Beckere0b150f2018-08-21 15:51:03 +01003661/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3662 *
3663 * Maximum number of heap-allocated bytes for the purpose of
3664 * DTLS handshake message reassembly and future message buffering.
3665 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003666 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003667 * to account for a reassembled handshake message of maximum size,
3668 * together with its reassembly bitmap.
3669 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003670 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003671 * should be sufficient for all practical situations as it allows
3672 * to reassembly a large handshake message (such as a certificate)
3673 * while buffering multiple smaller handshake messages.
3674 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003675 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003676//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003677
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003678//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3679//#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 +02003680
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003681/**
3682 * Complete list of ciphersuites to use, in order of preference.
3683 *
3684 * \warning No dependency checking is done on that field! This option can only
3685 * be used to restrict the set of available ciphersuites. It is your
3686 * responsibility to make sure the needed modules are active.
3687 *
3688 * Use this to save a few hundred bytes of ROM (default ordering of all
3689 * available ciphersuites) and a few to a few hundred bytes of RAM.
3690 *
3691 * The value below is only an example, not the default.
3692 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003693//#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 +02003694
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003695/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003696//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003697//#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 +01003698
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003699/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003700 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003701 * mbedtls_platform_zeroize(). This replaces the default implementation in
3702 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003703 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003704 * mbedtls_platform_zeroize() is a widely used function across the library to
3705 * zero a block of memory. The implementation is expected to be secure in the
3706 * sense that it has been written to prevent the compiler from removing calls
3707 * to mbedtls_platform_zeroize() as part of redundant code elimination
3708 * optimizations. However, it is difficult to guarantee that calls to
3709 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3710 * versions of the C language standards do not provide a secure implementation
3711 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3712 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003713 * example by using directives specific to their compiler, features from newer
3714 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003715 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003716 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003717//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003718
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003719/**
3720 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003721 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003722 * platform_util.c.
3723 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003724 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003725 * library will try to use safer implementations of this function, such as
3726 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003727 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003728 * using the standard gmtime(). In this case, calls from the library to
3729 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003730 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003731 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003732 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3733 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3734 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003735 */
Hanno Becker6a739782018-09-05 15:06:19 +01003736//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003737
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003738/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003739 * Enable the verified implementations of ECDH primitives from Project Everest
3740 * (currently only Curve25519). This feature changes the layout of ECDH
3741 * contexts and therefore is a compatibility break for applications that access
3742 * fields of a mbedtls_ecdh_context structure directly. See also
3743 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003744 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003745//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003746
Gilles Peskine611179c2022-04-13 23:04:48 +02003747/** \} name SECTION: Module configuration options */