blob: 921a74918fb47e889877f454be8a2983cf7fd4b1 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010051 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000052 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000053 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010054 * Required by:
55 * MBEDTLS_AESNI_C
56 * MBEDTLS_PADLOCK_C
57 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020058 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000061
Paul Bakkerf3b86c12011-01-27 15:24:17 +000062/**
Gilles Peskineed942f82017-06-08 15:19:20 +020063 * \def MBEDTLS_NO_UDBL_DIVISION
64 *
65 * The platform lacks support for double-width integer division (64-bit
66 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
67 *
68 * Used in:
69 * include/mbedtls/bignum.h
70 * library/bignum.c
71 *
72 * The bignum code uses double-width division to speed up some operations.
73 * Double-width division is often implemented in software that needs to
74 * be linked with the program. The presence of a double-width integer
75 * type is usually detected automatically through preprocessor macros,
76 * but the automatic detection cannot know whether the code needs to
77 * and can be linked with an implementation of division for that type.
78 * By default division is assumed to be usable if the type is present.
79 * Uncomment this option to prevent the use of double-width division.
80 *
81 * Note that division for the native integer type is always required.
82 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010083 * platform, but it need not support multiplication or division. In some
84 * cases it is also desirable to disable some double-width operations. For
85 * example, if double-width division is implemented in software, disabling
86 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020087 */
88//#define MBEDTLS_NO_UDBL_DIVISION
89
90/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020091 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
92 *
93 * The platform lacks support for 32x32 -> 64-bit multiplication.
94 *
95 * Used in:
96 * library/poly1305.c
97 *
98 * Some parts of the library may use multiplication of two unsigned 32-bit
99 * operands with a 64-bit result in order to speed up computations. On some
100 * platforms, this is not available in hardware and has to be implemented in
101 * software, usually in a library provided by the toolchain.
102 *
103 * Sometimes it is not desirable to have to link to that library. This option
104 * removes the dependency of that library on platforms that lack a hardware
105 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
106 *
107 * Note that depending on the compiler, this may decrease performance compared
108 * to using the library function provided by the toolchain.
109 */
110//#define MBEDTLS_NO_64BIT_MULTIPLICATION
111
112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000114 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000115 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000116 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200120
121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200123 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200124 * System has time.h and time().
125 * The time does not need to be correct, only time differences are used,
126 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100128 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
129 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
130 * MBEDTLS_PLATFORM_STD_TIME.
131 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400132 * Comment if your system does not support time functions.
133 *
134 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
135 * interface - timing.c will include time.h on suitable platforms
136 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
137 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100140
141/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200142 * \def MBEDTLS_HAVE_TIME_DATE
143 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100144 * System has time.h, time(), and an implementation for
145 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100146 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200147 * the date should be correct). This is used to verify the validity period of
148 * X.509 certificates.
149 *
150 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100151 *
Hanno Becker6a739782018-09-05 15:06:19 +0100152 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100153 * behaves similarly to the gmtime_r() function from the C standard. Refer to
154 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100155 *
156 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100157 * mbedtls_platform_gmtime_r() at compile-time by using the macro
158 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200159 */
160#define MBEDTLS_HAVE_TIME_DATE
161
162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 *
165 * Enable the memory allocation layer.
166 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 * This allows different allocators (self-implemented or provided) to be
169 * provided to the platform abstraction layer.
170 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200172 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
173 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * free() function pointer at runtime.
175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200177 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181 *
182 * Enable this layer to allow use of alternative memory allocators.
183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185
186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200188 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200189 * Do not assign standard functions in the platform layer (e.g. calloc() to
190 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
192 * This makes sure there are no linking errors on platforms that do not support
193 * these functions. You will HAVE to provide alternatives, either at runtime
194 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
196 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200197 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200199 *
200 * Uncomment to prevent default assignment of standard functions in the
201 * platform layer.
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200204
205/**
Janos Follathc351d182016-03-21 08:43:59 +0000206 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100208 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
209 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
212 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100213 * alternative printf function pointer.
214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100216 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200217 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
218 * it will be enabled automatically by check_config.h
219 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200220 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000222 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100223 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
224 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100225 * Uncomment a macro to enable alternate implementation of specific base
226 * platform function
227 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200228//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100230//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231//#define MBEDTLS_PLATFORM_FPRINTF_ALT
232//#define MBEDTLS_PLATFORM_PRINTF_ALT
233//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200234//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100235//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100236//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100237
238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100240 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000241 * Mark deprecated functions and features so that they generate a warning if
242 * used. Functionality deprecated in one version will usually be removed in the
243 * next version. You can enable this to help you prepare the transition to a
244 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 *
246 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100252
253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000256 * Remove deprecated functions and features so that they generate an error if
257 * used. Functionality deprecated in one version will usually be removed in the
258 * next version. You can enable this to help you prepare the transition to a
259 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000261 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100264
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100265/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000266
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000267/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000268 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000269 *
270 * This section sets support for features that are or are not needed
271 * within the modules that are enabled.
272 * \{
273 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100277 *
TRodziewiczd8540832021-06-10 15:16:50 +0200278 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200279 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100282 *
283 * You will need to provide a header "timing_alt.h" and an implementation at
284 * compile time.
285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100287
288/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100289 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200290 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100291 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100292 * alternate core implementation of a symmetric crypto, an arithmetic or hash
293 * module (e.g. platform specific assembly optimized implementations). Keep
294 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200295 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200296 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000300 * provide the "struct mbedtls_aes_context" definition and omit the base
301 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200302 * "aes.h" to include the new function definitions.
303 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200304 * Uncomment a macro to enable alternate implementation of the corresponding
305 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100306 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200307 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100308 * use constitutes a security risk. If possible, we recommend
309 * avoiding dependencies on them, and considering stronger message
310 * digests and ciphers instead.
311 *
Paul Bakker90995b52013-06-24 19:20:35 +0200312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000314//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200316//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300317//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200318//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200319//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000321//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000322//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100323//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300324//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300326//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000328//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329//#define MBEDTLS_SHA1_ALT
330//#define MBEDTLS_SHA256_ALT
331//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000332
Janos Follathb0697532016-08-18 12:38:46 +0100333/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800334 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100335 * implemented with two .c files:
336 * - ecp.c
337 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000338 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
339 * macros as described above. The only difference is that you have to make sure
340 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100341 */
342//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200343
344/**
TRodziewicz75628d52021-06-18 12:56:27 +0200345 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200346 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100347 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
348 * alternate core implementation of symmetric crypto or hash function. Keep in
349 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200350 *
351 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200353 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
355 * no longer provide the mbedtls_sha1_process() function, but it will still provide
356 * the other function (using your mbedtls_sha1_process() function) and the definition
357 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 * with this definition.
359 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200360 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100361 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
362 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200363 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 * Uncomment a macro to enable alternate implementation of the corresponding
365 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100366 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200367 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100368 * constitutes a security risk. If possible, we recommend avoiding
369 * dependencies on them, and considering stronger message digests
370 * and ciphers instead.
371 *
Janos Follath1231d212019-01-07 15:01:32 +0000372 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
373 * enabled, then the deterministic ECDH signature functions pass the
374 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
375 * alternative implementations should use the RNG only for generating
376 * the ephemeral key and nothing else. If this is not possible, then
377 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200378 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000379 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381//#define MBEDTLS_MD5_PROCESS_ALT
382//#define MBEDTLS_RIPEMD160_PROCESS_ALT
383//#define MBEDTLS_SHA1_PROCESS_ALT
384//#define MBEDTLS_SHA256_PROCESS_ALT
385//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200386//#define MBEDTLS_DES_SETKEY_ALT
387//#define MBEDTLS_DES_CRYPT_ECB_ALT
388//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200389//#define MBEDTLS_AES_SETKEY_ENC_ALT
390//#define MBEDTLS_AES_SETKEY_DEC_ALT
391//#define MBEDTLS_AES_ENCRYPT_ALT
392//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300393//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300394//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300395//#define MBEDTLS_ECDSA_VERIFY_ALT
396//#define MBEDTLS_ECDSA_SIGN_ALT
397//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398
399/**
Janos Follathc44ab972016-11-18 16:38:23 +0000400 * \def MBEDTLS_ECP_INTERNAL_ALT
401 *
402 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100403 *
404 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100405 * alternative core implementation of elliptic curve arithmetic. Keep in mind
406 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100407 *
408 * This partially replaces one function. The header file from mbed TLS is still
409 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
410 * is still present and it is used for group structures not supported by the
411 * alternative.
412 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100413 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100414 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100415 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
416 * able to fallback to curves not supported by the alternative implementation.
417 *
Janos Follathc44ab972016-11-18 16:38:23 +0000418 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
419 * and implementing the following functions:
420 * unsigned char mbedtls_internal_ecp_grp_capable(
421 * const mbedtls_ecp_group *grp )
422 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500423 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000424 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
425 * replacement functions implement arithmetic for the given group and 0
426 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500427 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000428 * called before and after each point operation and provide an opportunity to
429 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100430 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100431 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
432 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
433 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
434 * for the operation is supported by your implementation (i.e. your
435 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
436 * group is not supported by your implementation, then the original mbed TLS
437 * implementation of ecp_double_jac() is used instead, unless this fallback
438 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
439 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
440 *
441 * The function prototypes and the definition of mbedtls_ecp_group and
442 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
443 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
444 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100445 *
446 * Uncomment a macro to enable alternate implementation of the corresponding
447 * function.
448 */
449/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000450//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100451/* Turn off software fallback for curves not supported in hardware */
452//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100453/* Support for Weierstrass curves with Jacobi representation */
454//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
455//#define MBEDTLS_ECP_ADD_MIXED_ALT
456//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
457//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
458//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
459/* Support for curves with Montgomery arithmetic */
460//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
461//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
462//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
463
464/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200465 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200466 *
467 * Uncomment this macro to let mbed TLS use your own implementation of a
468 * hardware entropy collector.
469 *
470 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000471 * prototype as declared in library/entropy_poll.h, and accept NULL as first
472 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200473 *
474 * Uncomment to use your own hardware entropy collector.
475 */
476//#define MBEDTLS_ENTROPY_HARDWARE_ALT
477
478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000480 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100481 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000482 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100483 * Uncomment this macro to use precomputed AES tables stored in ROM.
484 * Comment this macro to generate AES tables in RAM at runtime.
485 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100486 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
487 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100488 * initialization time before the first AES operation can be performed.
489 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
490 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
491 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100492 *
493 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
494 *
Paul Bakker15566e42011-04-24 21:19:15 +0000495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000497
498/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100499 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200500 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100501 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200502 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100503 * Uncommenting this macro omits 75% of the AES tables from
504 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
505 * by computing their values on the fly during operations
506 * (the tables are entry-wise rotations of one another).
507 *
508 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100509 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100510 * runtime. Specifically, one has to compare 4 accesses within
511 * different tables to 4 accesses with additional arithmetic
512 * operations within the same table. The performance gain/loss
513 * depends on the system and memory details.
514 *
515 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
516 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200517 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100518//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200519
520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200522 *
523 * Use less ROM for the Camellia implementation (saves about 768 bytes).
524 *
525 * Uncomment this macro to use less memory for Camellia.
526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200528
529/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200530 * \def MBEDTLS_CHECK_RETURN_WARNING
531 *
532 * If this macro is defined, emit a compile-time warning if application code
533 * calls a function without checking its return value, but the return value
534 * should generally be checked in portable applications.
535 *
536 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
537 * implemented. Otherwise this option has no effect.
538 *
539 * Uncomment to get warnings on using fallible functions without checking
540 * their return value.
541 *
542 * \note This feature is a work in progress.
543 * Warnings will be added to more functions in the future.
544 *
545 * \note A few functions are considered critical, and ignoring the return
546 * value of these functions will trigger a warning even if this
547 * macro is not defined. To completely disable return value check
548 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
549 */
550//#define MBEDTLS_CHECK_RETURN_WARNING
551
552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200554 *
555 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200558
559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000561 *
562 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000565
566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000568 *
569 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000572
573/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100574 * \def MBEDTLS_CIPHER_MODE_OFB
575 *
576 * Enable Output Feedback mode (OFB) for symmetric ciphers.
577 */
578#define MBEDTLS_CIPHER_MODE_OFB
579
580/**
581 * \def MBEDTLS_CIPHER_MODE_XTS
582 *
583 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
584 */
585#define MBEDTLS_CIPHER_MODE_XTS
586
587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589 *
590 * Enable NULL cipher.
591 * Warning: Only do so when you know what you are doing. This allows for
592 * encryption or channels without any security!
593 *
Ronald Croncee42702021-04-26 11:34:44 +0200594 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
596 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
597 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
598 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
599 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
600 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
601 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
602 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
603 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
604 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
605 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
606 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
607 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
608 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
609 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
610 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
611 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
612 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
613 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000614 *
615 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000618
619/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100620 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200621 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100622 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
623 * specific padding modes in the cipher layer with cipher modes that support
624 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200625 *
626 * If you disable all padding modes, only full blocks can be used with CBC.
627 *
628 * Enable padding modes in the cipher layer.
629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630#define MBEDTLS_CIPHER_PADDING_PKCS7
631#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
632#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
633#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200634
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200635/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
636 *
637 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
638 * By default, CTR_DRBG uses a 256-bit key.
639 */
640//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
641
Paul Bakker48e93c82013-08-14 12:21:18 +0200642/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100643 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200644 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100645 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
646 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200647 *
648 * Comment macros to disable the curve and functions for it
649 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200650/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
654#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
655#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
656#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
657#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
658#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
659#define MBEDTLS_ECP_DP_BP256R1_ENABLED
660#define MBEDTLS_ECP_DP_BP384R1_ENABLED
661#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200662/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200663#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000664#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200665
666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200668 *
669 * Enable specific 'modulo p' routines for each NIST prime.
670 * Depending on the prime and architecture, makes operations 4 to 8 times
671 * faster on the corresponding curve.
672 *
673 * Comment this macro to disable NIST curves optimisation.
674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200676
677/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200678 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100679 *
680 * Enable "non-blocking" ECC operations that can return early and be resumed.
681 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200682 * This allows various functions to pause by returning
683 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
684 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
685 * order to further progress and eventually complete their operation. This is
686 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
687 * number of ECC operations a function may perform before pausing; see
688 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100689 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200690 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200691 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100692 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100693 * This option:
694 * - Adds xxx_restartable() variants of existing operations in the
695 * following modules, with corresponding restart context types:
696 * - ECP: scalar multiplication (mult), linear combination (muladd);
697 * - ECDSA: signature generation & verification;
698 * - PK: signature generation & verification;
699 * - X509: certificate chain verification.
700 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
701 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
702 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
703 * computations restartable:
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100704 * - ECDH operations from the key exchange - unless MBEDTLS_USE_PSA_CRYPTO
705 * is also enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100706 * - verification of the server's key exchange signature;
707 * - verification of the server's certificate chain;
708 * - generation of our signature if client authentication is used, with an
709 * ECC key/certificate.
710 *
711 * \note In the cases above, the usual SSL/TLS functions, such as
712 * mbedtls_ssl_handshake(), can now return
713 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200714 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100715 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
716 * restartable operations in PK, X.509 and TLS (see above) are not
717 * using PSA. On the other hand, ECDH computations in TLS are using
718 * PSA, and are not restartable.
719 *
Ron Eldor19779c42018-11-05 16:58:13 +0200720 * \note This option only works with the default software implementation of
721 * elliptic curve functionality. It is incompatible with
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100722 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100723 *
Manuel Pégourié-Gonnard57866462022-12-06 12:14:49 +0100724 * \note This option only works for Short Weierstrass curves.
725 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100726 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100727 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200728//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100729
730/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200731 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100732 *
733 * Enable deterministic ECDSA (RFC 6979).
734 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
735 * may result in a compromise of the long-term signing key. This is avoided by
736 * the deterministic variant.
737 *
John Durkop36a82e52020-10-26 09:39:05 -0700738 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100739 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100740 * Comment this macro to disable deterministic ECDSA.
741 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200742#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100743
744/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200745 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200746 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200747 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200748 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200749 * This enables the following ciphersuites (if other requisites are
750 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
752 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
753 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
754 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
755 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
756 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
757 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
758 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
759 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
760 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200766 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200767 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +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_DHE_PSK_WITH_AES_256_GCM_SHA384
774 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
775 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
776 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
777 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
778 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
779 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
780 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
781 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
782 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100783 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100784 * \warning Using DHE constitutes a security risk as it
785 * is not possible to validate custom DH parameters.
786 * If possible, it is recommended users should consider
787 * preferring other methods of key exchange.
788 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100789 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200792
793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200795 *
796 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200799 *
800 * This enables the following ciphersuites (if other requisites are
801 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
803 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
804 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
805 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
806 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
807 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200810
811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200814 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200815 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
817 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200818 *
819 * This enables the following ciphersuites (if other requisites are
820 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
822 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
823 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
824 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
825 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
826 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
827 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
828 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
829 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
830 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
840 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200841 *
842 * This enables the following ciphersuites (if other requisites are
843 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
845 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
846 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
847 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
848 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
849 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
850 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
851 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
852 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
853 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
854 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
855 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200858
859/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200862 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200864 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
865 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
867 * This enables the following ciphersuites (if other requisites are
868 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
870 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
871 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
872 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
873 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
874 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
875 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
876 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
877 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
878 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
879 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
880 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100881 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100882 * \warning Using DHE constitutes a security risk as it
883 * is not possible to validate custom DH parameters.
884 * If possible, it is recommended users should consider
885 * preferring other methods of key exchange.
886 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100887 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200888 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200889#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200890
891/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200893 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200894 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200895 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200896 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
897 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200898 *
899 * This enables the following ciphersuites (if other requisites are
900 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
902 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
903 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
904 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
905 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
906 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
907 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
908 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
909 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
910 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200913
914/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200917 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200918 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200920 *
921 * This enables the following ciphersuites (if other requisites are
922 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200923 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
924 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
926 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
929 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
930 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200935
936/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100938 *
939 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
940 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200941 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100942 *
943 * This enables the following ciphersuites (if other requisites are
944 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
947 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
948 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
952 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100955 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100957
958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100960 *
961 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
962 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200963 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100964 *
965 * This enables the following ciphersuites (if other requisites are
966 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200967 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
968 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
969 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
970 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
971 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
972 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
973 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
974 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
975 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
976 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100977 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200978#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100979
980/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200981 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
982 *
983 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
984 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200985 * \warning This is currently experimental. EC J-PAKE support is based on the
986 * Thread v1.0.0 specification; incompatible changes to the specification
987 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200988 *
989 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200990 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200991 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
992 *
993 * This enables the following ciphersuites (if other requisites are
994 * enabled as well):
995 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
996 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200997//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001001 *
1002 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1003 * RFC 5915 and RFC 5480.
1004 *
1005 * Currently this means parsing the SpecifiedECDomain choice of EC
1006 * parameters (only known groups are supported, not arbitrary domains, to
1007 * avoid validation issues).
1008 *
1009 * Disable if you only need to support RFC 5915 + 5480 key formats.
1010 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001012
1013/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001014 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001015 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * Enable a dummy error function to make use of mbedtls_strerror() in
1017 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1018 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001019 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1021 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001022 *
1023 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001027
1028/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001030 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001031 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001032 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001036
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001037/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001038 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001039 *
1040 * Enable functions that use the filesystem.
1041 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001042#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001043
1044/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001045 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001046 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001047 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001048 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001049 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001050 * application.
1051 *
1052 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001053 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001054//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001055
1056/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001057 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001058 *
1059 * Do not use built-in platform entropy functions.
1060 * This is useful if your platform does not support
1061 * standards like the /dev/urandom or Windows CryptoAPI.
1062 *
1063 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001065//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001066
1067/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001069 *
1070 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1071 * default SHA-512 based one (if both are available).
1072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001074 *
1075 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1076 * if you have performance concerns.
1077 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * This option is only useful if both MBEDTLS_SHA256_C and
1079 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001080 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001082
1083/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001084 * \def MBEDTLS_ENTROPY_NV_SEED
1085 *
1086 * Enable the non-volatile (NV) seed file-based entropy source.
1087 * (Also enables the NV seed read/write functions in the platform layer)
1088 *
1089 * This is crucial (if not required) on systems that do not have a
1090 * cryptographic entropy source (in hardware or kernel) available.
1091 *
1092 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1093 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001094 * \note The read/write functions that are used by the entropy source are
1095 * determined in the platform layer, and can be modified at runtime and/or
1096 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1097 *
1098 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001099 * with regular fopen(), please make sure you make a seedfile with the
1100 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1101 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001102 * and written to or you will get an entropy source error! The default
1103 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1104 * bytes from the file.
1105 *
1106 * \note The entropy collector will write to the seed file before entropy is
1107 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001108 */
1109//#define MBEDTLS_ENTROPY_NV_SEED
1110
Ronald Cron71016a92020-08-28 19:01:50 +02001111/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001112 *
Ronald Cron71016a92020-08-28 19:01:50 +02001113 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001114 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001115 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1116 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001117 *
1118 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001119 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001120 */
Ronald Cron71016a92020-08-28 19:01:50 +02001121//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001122
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001123/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001125 *
1126 * Enable debugging of buffer allocator memory issues. Automatically prints
1127 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1128 * function for 'debug output' of allocated memory.
1129 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001130 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001131 *
1132 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001135
1136/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001138 *
1139 * Include backtrace information with each allocated block.
1140 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001141 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001142 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001143 *
1144 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001145 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001146//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001147
1148/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001150 *
1151 * Support external private RSA keys (eg from a HSM) in the PK layer.
1152 *
1153 * Comment this macro to disable support for external private RSA keys.
1154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001156
1157/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001158 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001159 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001160 * Enable support for PKCS#1 v1.5 encoding.
1161 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001162 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001163 *
Paul Bakker48377d92013-08-30 12:06:24 +02001164 * This enables support for PKCS#1 v1.5 operations.
1165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001167
1168/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001170 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001171 * Enable support for PKCS#1 v2.1 encoding.
1172 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001173 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1174 *
1175 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1176 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001177 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001178 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01001179 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001180 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
1181 * this module in builds where MBEDTLS_MD_C is disabled.
1182 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001183 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001186
Steven Cooreman6801f082021-02-19 17:21:22 +01001187/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1188 *
1189 * Enable support for platform built-in keys. If you enable this feature,
1190 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1191 * See the documentation of that function for more information.
1192 *
1193 * Built-in keys are typically derived from a hardware unique key or
1194 * stored in a secure element.
1195 *
1196 * Requires: MBEDTLS_PSA_CRYPTO_C.
1197 *
1198 * \warning This interface is experimental and may change or be removed
1199 * without notice.
1200 */
1201//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1202
Ronald Cron3768ac12021-01-26 16:58:00 +01001203/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1204 *
1205 * Enable support for PSA crypto client.
1206 *
1207 * \note This option allows to include the code necessary for a PSA
1208 * crypto client when the PSA crypto implementation is not included in
1209 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1210 * code to set and get PSA key attributes.
1211 * The development of PSA drivers partially relying on the library to
1212 * fulfill the hardware gaps is another possible usage of this option.
1213 *
1214 * \warning This interface is experimental and may change or be removed
1215 * without notice.
1216 */
1217//#define MBEDTLS_PSA_CRYPTO_CLIENT
1218
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001219/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1220 *
1221 * Enable support for the experimental PSA crypto driver interface.
1222 *
John Durkop185764f2020-10-12 21:32:12 -07001223 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001224 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001225 * \warning This interface is experimental. We intend to maintain backward
1226 * compatibility with application code that relies on drivers,
1227 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001228 */
1229//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1230
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001231/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1232 *
1233 * Make the PSA Crypto module use an external random generator provided
1234 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1235 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001236 * \note This random generator must deliver random numbers with cryptographic
1237 * quality and high performance. It must supply unpredictable numbers
1238 * with a uniform distribution. The implementation of this function
1239 * is responsible for ensuring that the random generator is seeded
1240 * with sufficient entropy. If you have a hardware TRNG which is slow
1241 * or delivers non-uniform output, declare it as an entropy source
1242 * with mbedtls_entropy_add_source() instead of enabling this option.
1243 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001244 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001245 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1246 * and define a function called mbedtls_psa_external_get_random()
1247 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001248 * ```
1249 * psa_status_t mbedtls_psa_external_get_random(
1250 * mbedtls_psa_external_random_context_t *context,
1251 * uint8_t *output, size_t output_size, size_t *output_length);
1252 * );
1253 * ```
1254 * The \c context value is initialized to 0 before the first call.
1255 * The function must fill the \c output buffer with \p output_size bytes
1256 * of random data and set \c *output_length to \p output_size.
1257 *
1258 * Requires: MBEDTLS_PSA_CRYPTO_C
1259 *
1260 * \warning If you enable this option, code that uses the PSA cryptography
1261 * interface will not use any of the entropy sources set up for
1262 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1263 * enables.
1264 *
1265 * \note This option is experimental and may be removed without notice.
1266 */
1267//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1268
Paul Bakker9dcc3222011-03-08 14:16:06 +00001269/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001270 * \def MBEDTLS_PSA_CRYPTO_SPM
1271 *
1272 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1273 * Partition Manager) integration which separates the code into two parts: a
1274 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1275 * Environment).
1276 *
1277 * Module: library/psa_crypto.c
1278 * Requires: MBEDTLS_PSA_CRYPTO_C
1279 *
1280 */
1281//#define MBEDTLS_PSA_CRYPTO_SPM
1282
1283/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001284 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001285 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001286 * Enable support for entropy injection at first boot. This feature is
1287 * required on systems that do not have a built-in entropy source (TRNG).
1288 * This feature is currently not supported on systems that have a built-in
1289 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001290 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001291 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001292 *
1293 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001294//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001295
1296/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001298 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001299 * Do not use the Chinese Remainder Theorem
1300 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001301 *
1302 * Uncomment this macro to disable the use of CRT in RSA.
1303 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001304 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001306
1307/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001309 *
1310 * Enable the checkup functions (*_self_test).
1311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001313
1314/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001315 * \def MBEDTLS_SHA256_SMALLER
1316 *
1317 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1318 * lower performance.
1319 *
Adam Wolf039080f2019-09-10 09:53:08 -05001320 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001321 * performance and size. This version optimizes more aggressively for size at
1322 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1323 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1324 * 30%.
1325 *
1326 * Uncomment to enable the smaller implementation of SHA256.
1327 */
1328//#define MBEDTLS_SHA256_SMALLER
1329
1330/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001331 * \def MBEDTLS_SHA512_SMALLER
1332 *
1333 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1334 * lower performance.
1335 *
1336 * Uncomment to enable the smaller implementation of SHA512.
1337 */
1338//#define MBEDTLS_SHA512_SMALLER
1339
1340/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001342 *
1343 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001344 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001345 * with other servers, only debugging of failures is harder.
1346 *
1347 * The advantage of not sending alert messages, is that no information is given
1348 * about reasons for failures thus preventing adversaries of gaining intel.
1349 *
1350 * Enable sending of all alert messages
1351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001353
1354/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001355 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1356 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001357 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001358 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001359 * in the underlying transport. The CID functionality is described
1360 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001361 *
1362 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001363 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1364 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1365 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001366 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001367 * The maximum lengths of outgoing and incoming CIDs can be configured
1368 * through the options
1369 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1370 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1371 *
1372 * Requires: MBEDTLS_SSL_PROTO_DTLS
1373 *
1374 * Uncomment to enable the Connection ID extension.
1375 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001376#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1377
1378
1379/**
1380 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1381 *
1382 * Defines whether RFC 9146 (default) or the legacy version
1383 * (version draft-ietf-tls-dtls-connection-id-05,
1384 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1385 * is used.
1386 *
1387 * Set the value to 0 for the standard version, and
1388 * 1 for the legacy draft version.
1389 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001390 * \deprecated Support for the legacy version of the DTLS
1391 * Connection ID feature is deprecated. Please
1392 * switch to the standardized version defined
1393 * in RFC 9146 enabled by utilizing
1394 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1395 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1396 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001397 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1398 */
1399#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001400
1401/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001402 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1403 *
1404 * Enable asynchronous external private key operations in SSL. This allows
1405 * you to configure an SSL connection to call an external cryptographic
1406 * module to perform private key operations instead of performing the
1407 * operation inside the library.
1408 *
1409 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001410//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001411
1412/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001413 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1414 *
1415 * Enable serialization of the TLS context structures, through use of the
1416 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1417 *
1418 * This pair of functions allows one side of a connection to serialize the
1419 * context associated with the connection, then free or re-use that context
1420 * while the serialized state is persisted elsewhere, and finally deserialize
1421 * that state to a live context for resuming read/write operations on the
1422 * connection. From a protocol perspective, the state of the connection is
1423 * unaffected, in particular this is entirely transparent to the peer.
1424 *
1425 * Note: this is distinct from TLS session resumption, which is part of the
1426 * protocol and fully visible by the peer. TLS session resumption enables
1427 * establishing new connections associated to a saved session with shorter,
1428 * lighter handshakes, while context serialization is a local optimization in
1429 * handling a single, potentially long-lived connection.
1430 *
1431 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1432 * saved after the handshake to allow for more efficient serialization, so if
1433 * you don't need this feature you'll save RAM by disabling it.
1434 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001435 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1436 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001437 * Comment to disable the context serialization APIs.
1438 */
1439#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1440
1441/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001442 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001443 *
1444 * Enable the debug messages in SSL module for all issues.
1445 * Debug messages have been disabled in some places to prevent timing
1446 * attacks due to (unbalanced) debugging function calls.
1447 *
1448 * If you need all error reporting you should enable this during debugging,
1449 * but remove this for production servers that should log as well.
1450 *
1451 * Uncomment this macro to report all debug messages on errors introducing
1452 * a timing side-channel.
1453 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001455//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001457/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001458 *
1459 * Enable support for Encrypt-then-MAC, RFC 7366.
1460 *
1461 * This allows peers that both support it to use a more robust protection for
1462 * ciphersuites using CBC, providing deep resistance against timing attacks
1463 * on the padding or underlying cipher.
1464 *
1465 * This only affects CBC ciphersuites, and is useless if none is defined.
1466 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001467 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001468 *
1469 * Comment this macro to disable support for Encrypt-then-MAC
1470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001471#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001473/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001474 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001475 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1476 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001477 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001478 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001479 * attacks, but it is recommended to always use it (even if you disable
1480 * renegotiation), since it actually fixes a more fundamental issue in the
1481 * original SSL/TLS design, and has implications beyond Triple Handshake.
1482 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001483 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001484 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001485 * Comment this macro to disable support for Extended Master Secret.
1486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001488
Paul Bakkerd66f0702013-01-31 16:57:45 +01001489/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001490 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1491 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001492 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001493 * giving access to the peer's certificate after completion of the handshake.
1494 *
1495 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1496 * recommended to disable this option for reduced RAM usage.
1497 *
1498 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1499 * defined, but always returns \c NULL.
1500 *
1501 * \note This option has no influence on the protection against the
1502 * triple handshake attack. Even if it is disabled, Mbed TLS will
1503 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001504 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001505 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001506 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1507 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001508 * Comment this macro to disable storing the peer's certificate
1509 * after the handshake.
1510 */
1511#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1512
1513/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001515 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001516 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001517 *
1518 * The two main uses of renegotiation are (1) refresh keys on long-lived
1519 * connections and (2) client authentication after the initial handshake.
1520 * If you don't need renegotiation, it's probably better to disable it, since
1521 * it has been associated with security issues in the past and is easy to
1522 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001523 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001524 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001525 *
1526 * \note Even if this option is disabled, both client and server are aware
1527 * of the Renegotiation Indication Extension (RFC 5746) used to
1528 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1529 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1530 * configuration of this extension).
1531 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001534
1535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001537 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001538 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001539 *
1540 * Comment this macro to disable support for the max_fragment_length extension
1541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001542#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001543
1544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001546 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001547 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001548 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001549 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1550 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1551 * With MBEDTLS_USE_PSA_CRYPTO:
1552 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1553 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001554 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001555 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1556 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001557 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001558 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001561
1562/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001563 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001564 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001565 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001566 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001567 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1568 * pre-shared keys are not supported.
1569 * See docs/architecture/tls13-support.md for a description of the TLS
1570 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001571 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001572 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001573 * Requires: MBEDTLS_PSA_CRYPTO_C
1574 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001575 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1576 * for most operations, if you want it to only use PSA for all crypto
1577 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1578 * operations, and functions that are common with TLS 1.2 (record protection,
1579 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001580 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001581 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001582 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001583//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001584
1585/**
Ronald Cronab65c522021-11-24 10:47:20 +01001586 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1587 *
1588 * Enable TLS 1.3 middlebox compatibility mode.
1589 *
1590 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1591 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1592 * expecting TLS 1.2 traffic.
1593 *
1594 * Turning on the compatibility mode comes at the cost of a few added bytes
1595 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1596 * that don't use it. Therefore, unless transmission bandwidth is critical and
1597 * you know that middlebox compatibility issues won't occur, it is therefore
1598 * recommended to set this option.
1599 *
1600 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001601 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1602 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001603 *
1604 */
1605//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1606
1607/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001608 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1609 *
1610 * Enable TLS 1.3 PSK key exchange mode.
1611 *
1612 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1613 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1614 * effect on the build.
1615 *
1616 */
1617#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1618
1619/**
1620 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1621 *
1622 * Enable TLS 1.3 ephemeral key exchange mode.
1623 *
1624 * Requires: MBEDTLS_ECDH_C, MBEDTLS_X509_CRT_PARSE_C, MBEDTLS_ECDSA_C or
1625 * MBEDTLS_PKCS1_V21
1626 *
1627 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1628 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1629 * effect on the build.
1630 *
1631 */
1632#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1633
1634/**
1635 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1636 *
1637 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1638 *
1639 * Requires: MBEDTLS_ECDH_C
1640 *
1641 * Comment to disable support for the PSK ephemeral key exchange mode in
1642 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1643 * have any effect on the build.
1644 *
1645 */
1646#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1647
1648/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001649 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001650 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001651 * Maximum time difference in milliseconds tolerated between the age of a
1652 * ticket from the server and client point of view.
1653 * From the client point of view, the age of a ticket is the time difference
1654 * between the time when the client proposes to the server to use the ticket
1655 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1656 * the time the client received the ticket from the server.
1657 * From the server point of view, the age of a ticket is the time difference
1658 * between the time when the server receives a proposition from the client
1659 * to use the ticket and the time when the ticket was created by the server.
1660 * The server age is expected to be always greater than the client one and
1661 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1662 * maximum difference tolerated for the server to accept the ticket.
1663 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001664 *
1665 */
1666#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1667
1668/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001669 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1670 *
1671 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1672 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001673 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001674 */
Jerry Yu9750f812022-07-20 11:04:50 +08001675#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001676
1677/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001678 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1679 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001680 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1681 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1682 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001683 *
1684 */
1685#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1686
1687/**
Xiaokang Qian54413b12022-10-20 05:57:03 +00001688* \def MBEDTLS_SSL_EARLY_DATA
1689*
Xiaokang Qian600804b2022-10-20 09:22:38 +00001690* Enable support for RFC 8446 TLS 1.3 early data.
Xiaokang Qian54413b12022-10-20 05:57:03 +00001691*
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001692* Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1693* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1694* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Xiaokang Qian600804b2022-10-20 09:22:38 +00001695*
Xiaokang Qian4ef4c892022-10-25 13:39:16 +00001696* Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
Xiaokang Qian402bb1e2022-11-10 10:38:17 +00001697* is not enabled, this option does not have any effect on the build.
Xiaokang Qian95a07302022-10-25 02:56:00 +00001698*
1699* This feature is experimental, not completed and thus not ready for
1700* production.
1701*
Xiaokang Qian54413b12022-10-20 05:57:03 +00001702*/
Ronald Cronc2e110f2022-11-22 09:01:46 +01001703//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001704
1705/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001707 *
1708 * Enable support for DTLS (all available versions).
1709 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001710 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001711 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001712 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001713 *
1714 * Comment this macro to disable support for DTLS
1715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001716#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001717
1718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001720 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001721 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001722 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001723 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001724 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001725#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001726
1727/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001729 *
1730 * Enable support for the anti-replay mechanism in DTLS.
1731 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001732 * Requires: MBEDTLS_SSL_TLS_C
1733 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001734 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001735 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001736 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001738 * Comment this to disable anti-replay in DTLS.
1739 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001740#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001741
1742/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001743 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001744 *
1745 * Enable support for HelloVerifyRequest on DTLS servers.
1746 *
1747 * This feature is highly recommended to prevent DTLS servers being used as
1748 * amplifiers in DoS attacks against other hosts. It should always be enabled
1749 * unless you know for sure amplification cannot be a problem in the
1750 * environment in which your server operates.
1751 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001752 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001753 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001754 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001755 *
1756 * Comment this to disable support for HelloVerifyRequest.
1757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001759
1760/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001761 * \def MBEDTLS_SSL_DTLS_SRTP
1762 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001763 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001764 * through the use_srtp extension.
1765 *
1766 * \note This feature provides the minimum functionality required
1767 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1768 * the associated SRTP packet protection key material.
1769 * In particular, the SRTP packet protection itself, as well as the
1770 * demultiplexing of RTP and DTLS packets at the datagram layer
1771 * (see Section 5 of RFC 5764), are not handled by this feature.
1772 * Instead, after successful completion of a handshake negotiating
1773 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001774 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001775 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1776 * (this is implemented in the SSL example programs).
1777 * The resulting key should then be passed to an SRTP stack.
1778 *
1779 * Setting this option enables the runtime API
1780 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1781 * through which the supported DTLS-SRTP protection
1782 * profiles can be configured. You must call this API at
1783 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001784 *
1785 * Requires: MBEDTLS_SSL_PROTO_DTLS
1786 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001787 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001788 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001789//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001790
1791/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001792 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1793 *
1794 * Enable server-side support for clients that reconnect from the same port.
1795 *
1796 * Some clients unexpectedly close the connection and try to reconnect using the
1797 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001798 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001799 * flag enables that support.
1800 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001801 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001802 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001803 * Comment this to disable support for clients reusing the source port.
1804 */
1805#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1806
1807/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001809 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001810 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001811 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001812 * session store remains the responsibility of the application, though).
1813 * Server-side, you also need to provide callbacks for writing and parsing
1814 * tickets, including authenticated encryption and key management. Example
1815 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001816 *
1817 * Comment this macro to disable support for SSL session tickets
1818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001819#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001820
1821/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001823 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001824 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001826 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001827 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001828 * Comment this macro to disable support for server name indication in SSL
1829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001831
1832/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001833 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1834 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001835 * When this option is enabled, the SSL buffer will be resized automatically
1836 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001837 *
1838 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001839 */
1840//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1841
1842/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001843 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1844 *
1845 * Enable testing of the constant-flow nature of some sensitive functions with
1846 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001847 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001848 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001849 * This setting requires compiling with clang -fsanitize=memory. The test
1850 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001851 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001852 * \warning This macro is only used for extended testing; it is not considered
1853 * part of the library's API, so it may change or disappear at any time.
1854 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001855 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001856 */
1857//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1858
1859/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001860 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1861 *
1862 * Enable testing of the constant-flow nature of some sensitive functions with
1863 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001864 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001865 *
1866 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001867 * testing if the tests suites are run with valgrind's memcheck. This can be
1868 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1869 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001870 *
1871 * \warning This macro is only used for extended testing; it is not considered
1872 * part of the library's API, so it may change or disappear at any time.
1873 *
1874 * Uncomment to enable testing of the constant-flow nature of selected code.
1875 */
1876//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1877
1878/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001879 * \def MBEDTLS_TEST_HOOKS
1880 *
1881 * Enable features for invasive testing such as introspection functions and
1882 * hooks for fault injection. This enables additional unit tests.
1883 *
1884 * Merely enabling this feature should not change the behavior of the product.
1885 * It only adds new code, and new branching points where the default behavior
1886 * is the same as when this feature is disabled.
1887 * However, this feature increases the attack surface: there is an added
1888 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1889 * Therefore this feature must never be enabled in production.
1890 *
1891 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1892 * information.
1893 *
1894 * Uncomment to enable invasive tests.
1895 */
1896//#define MBEDTLS_TEST_HOOKS
1897
1898/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001900 *
1901 * Provide your own alternate threading implementation.
1902 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001903 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001904 *
1905 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001906 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001908
1909/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001910 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001911 *
1912 * Enable the pthread wrapper layer for the threading layer.
1913 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001915 *
1916 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001917 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001918//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001919
1920/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001921 * \def MBEDTLS_USE_PSA_CRYPTO
1922 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001923 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1924 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001925 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001926 * \note Development of this option is currently in progress, and parts of Mbed
1927 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001928 * will still continue to work as usual, so enabling this option should not
1929 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001930 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001931 * \note See docs/use-psa-crypto.md for a complete description of what this
1932 * option currently does, and of parts that are not affected by it so far.
1933 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001934 * \warning If you enable this option, you need to call `psa_crypto_init()`
1935 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001936 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001937 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001938 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001939 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001940 */
1941//#define MBEDTLS_USE_PSA_CRYPTO
1942
1943/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001944 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1945 *
John Durkop185764f2020-10-12 21:32:12 -07001946 * This setting allows support for cryptographic mechanisms through the PSA
1947 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001948 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001949 * When this option is disabled, the PSA API exposes the cryptographic
1950 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1951 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001952 *
1953 * When this option is enabled, the PSA API exposes the cryptographic
1954 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1955 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1956 * automatically enabled if required (i.e. if no PSA driver provides the
1957 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1958 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001959 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001960 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001961 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001962 *
John Durkop185764f2020-10-12 21:32:12 -07001963 * This feature is still experimental and is not ready for production since
1964 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001965 */
1966//#define MBEDTLS_PSA_CRYPTO_CONFIG
1967
1968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001970 *
1971 * Allow run-time checking of compile-time enabled features. Thus allowing users
1972 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001974 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001975 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001976 *
1977 * Comment this to disable run-time checking and save ROM space
1978 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001980
1981/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001982 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1983 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001984 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001985 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1986 * the set of trusted certificates through a callback instead of a linked
1987 * list.
1988 *
1989 * This is useful for example in environments where a large number of trusted
1990 * certificates is present and storing them in a linked list isn't efficient
1991 * enough, or when the set of trusted certificates changes frequently.
1992 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001993 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001994 * `mbedtls_ssl_conf_ca_cb()` for more information.
1995 *
1996 * Uncomment to enable trusted certificate callbacks.
1997 */
1998//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1999
2000/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002001 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002002 *
Chris Jones2c745862020-12-16 11:41:06 +00002003 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002004 *
Chris Jones2c745862020-12-16 11:41:06 +00002005 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002006 * and other functions/constants only used by these functions, thus reducing
2007 * the code footprint by several KB.
2008 */
Chris Jones2c745862020-12-16 11:41:06 +00002009//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002010
2011/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002013 *
2014 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2015 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2016 *
2017 * Comment this macro to disallow using RSASSA-PSS in certificates.
2018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002020/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002021
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002022/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002023 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002024 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002025 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002026 * \{
2027 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002028
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002031 *
2032 * Enable AES-NI support on x86-64.
2033 *
2034 * Module: library/aesni.c
2035 * Caller: library/aes.c
2036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002038 *
2039 * This modules adds support for the AES-NI instructions on x86-64
2040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002041#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002042
2043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002044 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002045 *
2046 * Enable the AES block cipher.
2047 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002048 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002049 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002050 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002051 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002052 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002053 * This module enables the following ciphersuites (if other requisites are
2054 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2056 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2057 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2058 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2059 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2060 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2061 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2062 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2063 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2064 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2065 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2066 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2067 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2068 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2069 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2070 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2071 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2072 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2073 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2074 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2075 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2076 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2077 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2078 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2079 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2080 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2081 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2082 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2083 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2084 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2085 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2086 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2087 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2088 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2089 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2090 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2091 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2092 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2093 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2094 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2095 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2096 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2097 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2098 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2099 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2100 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2101 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2102 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2103 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2104 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2105 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2106 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2107 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2108 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2109 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2110 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2111 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2112 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002113 *
Paul Bakkercff68422013-09-15 20:43:33 +02002114 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002115 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002116#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002117
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002120 *
2121 * Enable the generic ASN1 parser.
2122 *
2123 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002124 * Caller: library/x509.c
2125 * library/dhm.c
2126 * library/pkcs12.c
2127 * library/pkcs5.c
2128 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002131
2132/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002133 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002134 *
2135 * Enable the generic ASN1 writer.
2136 *
2137 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002138 * Caller: library/ecdsa.c
2139 * library/pkwrite.c
2140 * library/x509_create.c
2141 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002142 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002144#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002145
2146/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002147 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002148 *
2149 * Enable the Base64 module.
2150 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002151 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002152 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002153 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002154 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002157
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002159 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002160 *
Paul Bakker9a736322012-11-14 12:39:52 +00002161 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002162 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002164 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002165 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002166 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002167 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002168 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002169 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002170 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002171 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002172 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002173 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002174 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002175 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002177
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002180 *
2181 * Enable the Camellia block cipher.
2182 *
Paul Bakker38119b12009-01-10 23:31:23 +00002183 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002184 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002185 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002186 * This module enables the following ciphersuites (if other requisites are
2187 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2189 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2190 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2191 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2192 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2193 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2194 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2195 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2196 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2197 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2198 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2199 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2200 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2201 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2202 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2203 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2204 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2205 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2206 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2207 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2208 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2209 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2210 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2211 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2212 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2213 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2214 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2215 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2216 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2217 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2218 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2219 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2220 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2221 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2222 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2223 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2224 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2225 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2226 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2227 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2228 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2229 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002230 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002231#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002232
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002233/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002234 * \def MBEDTLS_ARIA_C
2235 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002236 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002237 *
2238 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002239 * Caller: library/cipher.c
2240 *
2241 * This module enables the following ciphersuites (if other requisites are
2242 * enabled as well):
2243 *
2244 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2245 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2246 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2247 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2248 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2249 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2250 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2251 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2252 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2253 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2254 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2255 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2256 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2257 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2258 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2259 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2260 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2261 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2262 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2263 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2264 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2265 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2266 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2267 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2268 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2269 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2270 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2271 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2272 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2273 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2274 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2275 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2276 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2277 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2278 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2279 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2280 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2281 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002282 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002283#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002284
2285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002287 *
2288 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2289 *
2290 * Module: library/ccm.c
2291 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002292 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2293 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002294 *
2295 * This module enables the AES-CCM ciphersuites, if other requisites are
2296 * enabled as well.
2297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002299
2300/**
Daniel King34b822c2016-05-15 17:28:08 -03002301 * \def MBEDTLS_CHACHA20_C
2302 *
2303 * Enable the ChaCha20 stream cipher.
2304 *
2305 * Module: library/chacha20.c
2306 */
2307#define MBEDTLS_CHACHA20_C
2308
2309/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002310 * \def MBEDTLS_CHACHAPOLY_C
2311 *
2312 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2313 *
2314 * Module: library/chachapoly.c
2315 *
2316 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2317 */
2318#define MBEDTLS_CHACHAPOLY_C
2319
2320/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002322 *
2323 * Enable the generic cipher layer.
2324 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002325 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002326 * Caller: library/ccm.c
2327 * library/cmac.c
2328 * library/gcm.c
2329 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002330 * library/pkcs12.c
2331 * library/pkcs5.c
2332 * library/psa_crypto_aead.c
2333 * library/psa_crypto_mac.c
2334 * library/ssl_ciphersuites.c
2335 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002336 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002337 *
2338 * Uncomment to enable generic cipher wrappers.
2339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002341
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002342/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002343 * \def MBEDTLS_CMAC_C
2344 *
Simon Butcher327398a2016-10-05 14:09:11 +01002345 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2346 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002347 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002348 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2349 * implementation of the CMAC algorithm is provided by an alternate
2350 * implementation, that alternate implementation may opt to not support
2351 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2352 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002353 * Module: library/cmac.c
2354 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002355 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002356 *
2357 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002358#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002359
2360/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002362 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002363 * Enable the CTR_DRBG AES-based random generator.
2364 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002365 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002366 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002367 * \note To achieve a 256-bit security strength with CTR_DRBG,
2368 * you must use AES-256 *and* use sufficient entropy.
2369 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002370 *
2371 * Module: library/ctr_drbg.c
2372 * Caller:
2373 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002375 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002376 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002377 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002379
2380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002382 *
2383 * Enable the debug functions.
2384 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002385 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002386 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002387 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002388 * library/ssl_tls12_*.c
2389 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002390 *
2391 * This module provides debugging functions.
2392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002394
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002395/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002397 *
2398 * Enable the DES block cipher.
2399 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002400 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002401 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002402 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002403 *
Paul Bakkercff68422013-09-15 20:43:33 +02002404 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002405 *
2406 * \warning DES is considered a weak cipher and its use constitutes a
2407 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002408 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002410
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002413 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002414 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002415 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002416 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002417 * Caller: library/ssl_tls.c
2418 * library/ssl*_client.c
2419 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002420 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002421 * This module is used by the following key exchanges:
2422 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002423 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002424 * \warning Using DHE constitutes a security risk as it
2425 * is not possible to validate custom DH parameters.
2426 * If possible, it is recommended users should consider
2427 * preferring other methods of key exchange.
2428 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002429 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002432
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002435 *
2436 * Enable the elliptic curve Diffie-Hellman library.
2437 *
2438 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002439 * Caller: library/psa_crypto.c
2440 * library/ssl_tls.c
2441 * library/ssl*_client.c
2442 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002443 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002444 * This module is used by the following key exchanges:
2445 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002446 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002448 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002449#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002450
2451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002453 *
2454 * Enable the elliptic curve DSA library.
2455 *
2456 * Module: library/ecdsa.c
2457 * Caller:
2458 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002459 * This module is used by the following key exchanges:
2460 * ECDHE-ECDSA
2461 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002462 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2463 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2464 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002466#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002467
2468/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002469 * \def MBEDTLS_ECJPAKE_C
2470 *
2471 * Enable the elliptic curve J-PAKE library.
2472 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002473 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2474 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002475 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002476 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002477 * Module: library/ecjpake.c
2478 * Caller:
2479 *
2480 * This module is used by the following key exchanges:
2481 * ECJPAKE
2482 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002483 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002484 *
2485 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2486 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002487 *
2488 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002489 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002490 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2491 * this module in builds where MBEDTLS_MD_C is disabled.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002492 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002493#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002494
2495/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002497 *
2498 * Enable the elliptic curve over GF(p) library.
2499 *
2500 * Module: library/ecp.c
2501 * Caller: library/ecdh.c
2502 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002503 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002508
2509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002511 *
2512 * Enable the platform-specific entropy code.
2513 *
2514 * Module: library/entropy.c
2515 * Caller:
2516 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002517 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002518 *
2519 * This module provides a generic entropy pool
2520 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002521#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002522
2523/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002525 *
2526 * Enable error code to error string conversion.
2527 *
2528 * Module: library/error.c
2529 * Caller:
2530 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002534
2535/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002536 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002537 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002538 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002539 *
2540 * Module: library/gcm.c
2541 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002542 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2543 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002544 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002545 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2546 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002548#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002549
2550/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002551 * \def MBEDTLS_HKDF_C
2552 *
2553 * Enable the HKDF algorithm (RFC 5869).
2554 *
2555 * Module: library/hkdf.c
2556 * Caller:
2557 *
2558 * Requires: MBEDTLS_MD_C
2559 *
2560 * This module adds support for the Hashed Message Authentication Code
2561 * (HMAC)-based key derivation function (HKDF).
2562 */
2563#define MBEDTLS_HKDF_C
2564
2565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002567 *
2568 * Enable the HMAC_DRBG random generator.
2569 *
2570 * Module: library/hmac_drbg.c
2571 * Caller:
2572 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002574 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002575 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002578
2579/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002580 * \def MBEDTLS_LMS_C
2581 *
2582 * Enable the LMS stateful-hash asymmetric signature algorithm.
2583 *
2584 * Module: library/lms.c
2585 * Caller:
2586 *
Raef Colesab4f8742022-09-01 12:24:31 +01002587 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002588 *
Raef Colesab4f8742022-09-01 12:24:31 +01002589 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002590 */
2591#define MBEDTLS_LMS_C
2592
2593/**
Raef Colesab4f8742022-09-01 12:24:31 +01002594 * \def MBEDTLS_LMS_PRIVATE
2595 *
2596 * Enable LMS private-key operations and signing code. Functions enabled by this
2597 * option are experimental, and should not be used in production.
2598 *
2599 * Requires: MBEDTLS_LMS_C
2600 *
2601 * Uncomment to enable the LMS signature algorithm and private key operations.
2602 */
Raef Coles5127e852022-10-07 10:35:56 +01002603//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002604
2605/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002606 * \def MBEDTLS_NIST_KW_C
2607 *
2608 * Enable the Key Wrapping mode for 128-bit block ciphers,
2609 * as defined in NIST SP 800-38F. Only KW and KWP modes
2610 * are supported. At the moment, only AES is approved by NIST.
2611 *
2612 * Module: library/nist_kw.c
2613 *
2614 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2615 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002616#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002617
2618/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002620 *
2621 * Enable the generic message digest layer.
2622 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002623 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2624 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2625 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002626 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002627 * Caller: library/constant_time.c
2628 * library/ecdsa.c
2629 * library/ecjpake.c
2630 * library/hkdf.c
2631 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002632 * library/pk.c
2633 * library/pkcs5.c
2634 * library/pkcs12.c
2635 * library/psa_crypto_ecp.c
2636 * library/psa_crypto_rsa.c
2637 * library/rsa.c
2638 * library/ssl_cookie.c
2639 * library/ssl_msg.c
2640 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002641 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002642 * library/x509_crt.c
2643 * library/x509write_crt.c
2644 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002645 *
2646 * Uncomment to enable generic message digest wrappers.
2647 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002648#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002649
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002650/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002651 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002652 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002653 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002654 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002655 * Module: library/md5.c
2656 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002657 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002658 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002659 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002660 * This module is required for TLS 1.2 depending on the handshake parameters.
2661 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2662 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002663 *
2664 * \warning MD5 is considered a weak message digest and its use constitutes a
2665 * security risk. If possible, we recommend avoiding dependencies on
2666 * it, and considering stronger message digests instead.
2667 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002670
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002672 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002673 *
2674 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002675 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002676 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002677 *
2678 * Module: library/memory_buffer_alloc.c
2679 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680 * Requires: MBEDTLS_PLATFORM_C
2681 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002682 *
2683 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002684 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002685//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002686
2687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002688 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002689 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002690 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2691 *
Simon Butcherd567a232016-03-09 20:19:21 +00002692 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2693 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002694 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002695 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002696 * \note See also our Knowledge Base article about porting to a new
2697 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002698 * 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 +00002699 *
Andres AG788aa4a2016-09-14 14:32:09 +01002700 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002701 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002702 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002703 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002704#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002705
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002708 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002709 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002710 *
2711 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002712 * Caller: library/asn1write.c
2713 * library/pkcs5.c
2714 * library/pkparse.c
2715 * library/pkwrite.c
2716 * library/rsa.c
2717 * library/x509.c
2718 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002719 * library/x509_crl.c
2720 * library/x509_crt.c
2721 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002722 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002723 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002724 *
2725 * This modules translates between OIDs and internal values.
2726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002727#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002728
2729/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002730 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002731 *
2732 * Enable VIA Padlock support on x86.
2733 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002734 * Module: library/padlock.c
2735 * Caller: library/aes.c
2736 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002738 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002739 * This modules adds support for the VIA PadLock on x86.
2740 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002742
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002743/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002745 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002746 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002747 *
2748 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002749 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002750 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002751 * library/x509_crl.c
2752 * library/x509_crt.c
2753 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002754 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002755 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002756 *
Paul Bakkercff68422013-09-15 20:43:33 +02002757 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002758 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002759#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002760
2761/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002762 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002763 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002764 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002765 *
2766 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002767 * Caller: library/pkwrite.c
2768 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002769 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002770 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002772 *
2773 * This modules adds support for encoding / writing PEM files.
2774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002776
2777/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002778 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002779 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002780 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002781 *
2782 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002783 * Caller: library/psa_crypto_rsa.c
2784 * library/ssl_tls.c
2785 * library/ssl*_client.c
2786 * library/ssl*_server.c
2787 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002788 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002789 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002790 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002791 * Uncomment to enable generic public key wrappers.
2792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002794
2795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002797 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002798 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002799 *
2800 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002801 * Caller: library/x509_crt.c
2802 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002805 *
2806 * Uncomment to enable generic public key parse functions.
2807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002808#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002809
2810/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002811 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002812 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002813 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002814 *
2815 * Module: library/pkwrite.c
2816 * Caller: library/x509write.c
2817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002818 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002819 *
2820 * Uncomment to enable generic public key write functions.
2821 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002822#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002823
2824/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002826 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002827 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002828 *
2829 * Module: library/pkcs5.c
2830 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002831 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2832 *
2833 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2834 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002835 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002836 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002837 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002838 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2839 * this module in builds where MBEDTLS_MD_C is disabled.
2840 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002841 * This module adds support for the PKCS#5 functions.
2842 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002844
2845/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002846 * \def MBEDTLS_PKCS7_C
2847 *
Dave Rodgmandbcbf442022-12-05 11:15:10 +00002848 * This feature is a work in progress and not ready for production. Testing and
2849 * validation is incomplete, and handling of malformed inputs may not be robust.
2850 * The API may change.
Dave Rodgman6ebaf7a2022-12-01 18:33:58 +00002851 *
Nayna Jainc9deb182020-11-16 19:03:12 +00002852 * Enable PKCS7 core for using PKCS7 formatted signatures.
2853 * RFC Link - https://tools.ietf.org/html/rfc2315
2854 *
2855 * Module: library/pkcs7.c
2856 *
2857 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002858 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2859 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002860 *
2861 * This module is required for the PKCS7 parsing modules.
2862 */
Dave Rodgmanbc5f03d2022-12-01 12:36:57 +00002863//#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002864
2865/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002866 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002867 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002868 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002869 * Adds algorithms for parsing PKCS#8 encrypted private keys
2870 *
2871 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002872 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002873 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002874 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2875 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2876 *
2877 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2878 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002879 *
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002880 * \warning When building with MBEDTLS_MD_C, all hashes used with this
Manuel Pégourié-Gonnardfecc6b22022-11-24 09:40:12 +01002881 * need to be available as built-ins (that is, for SHA-256, MBEDTLS_SHA256_C,
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002882 * etc.) as opposed to just PSA drivers. So far, PSA drivers are only used by
2883 * this module in builds where MBEDTLS_MD_C is disabled.
2884 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002885 * This module enables PKCS#12 functions.
2886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002888
2889/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002891 *
2892 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002893 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002894 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002895 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2896 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002897 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002898 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002899 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002900 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002901 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002902 * Module: library/platform.c
2903 * Caller: Most other .c files
2904 *
2905 * This module enables abstraction of common (libc) functions.
2906 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002907#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002908
2909/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002910 * \def MBEDTLS_POLY1305_C
2911 *
2912 * Enable the Poly1305 MAC algorithm.
2913 *
2914 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002915 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002916 */
2917#define MBEDTLS_POLY1305_C
2918
2919/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002920 * \def MBEDTLS_PSA_CRYPTO_C
2921 *
2922 * Enable the Platform Security Architecture cryptography API.
2923 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002924 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002925 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002926 * Requires: MBEDTLS_CIPHER_C,
2927 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002928 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002929 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002930 *
2931 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002932#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002933
2934/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002935 * \def MBEDTLS_PSA_CRYPTO_SE_C
2936 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002937 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002938 * cryptography API.
2939 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002940 * \deprecated This feature is deprecated. Please switch to the driver
2941 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002942 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002943 * Module: library/psa_crypto_se.c
2944 *
2945 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2946 *
2947 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002948//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002949
2950/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002951 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2952 *
2953 * Enable the Platform Security Architecture persistent key storage.
2954 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002955 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002956 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002957 * Requires: MBEDTLS_PSA_CRYPTO_C,
2958 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2959 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002960 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002961#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002962
2963/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002964 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002965 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002966 * Enable the emulation of the Platform Security Architecture
2967 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002968 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002969 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002970 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002971 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002972 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002973#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002974
2975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002976 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002977 *
2978 * Enable the RIPEMD-160 hash algorithm.
2979 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002980 * Module: library/ripemd160.c
2981 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002982 *
2983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002984#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002985
2986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002988 *
2989 * Enable the RSA public-key cryptosystem.
2990 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002991 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002992 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002993 * Caller: library/pk.c
2994 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002995 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002996 * library/ssl*_client.c
2997 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002998 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002999 * This module is used by the following key exchanges:
3000 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003001 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003004#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003005
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003006/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003007 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003008 *
3009 * Enable the SHA1 cryptographic hash algorithm.
3010 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003011 * Module: library/sha1.c
3012 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003013 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003014 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003015 * This module is required for TLS 1.2 depending on the handshake parameters,
3016 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003017 *
3018 * \warning SHA-1 is considered a weak message digest and its use constitutes
3019 * a security risk. If possible, we recommend avoiding dependencies
3020 * on it, and considering stronger message digests instead.
3021 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003024
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003025/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003026 * \def MBEDTLS_SHA224_C
3027 *
3028 * Enable the SHA-224 cryptographic hash algorithm.
3029 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003030 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02003031 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003032 *
3033 * Module: library/sha256.c
3034 * Caller: library/md.c
3035 * library/ssl_cookie.c
3036 *
3037 * This module adds support for SHA-224.
3038 */
3039#define MBEDTLS_SHA224_C
3040
3041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003042 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003043 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003044 * Enable the SHA-256 cryptographic hash algorithm.
3045 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02003046 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003047 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003048 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003049 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003050 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003051 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003052 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003053 * library/ssl*_client.c
3054 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003055 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003056 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003057 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003058 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003059#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003060
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003062 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3063 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003064 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3065 * with the ARMv8 cryptographic extensions if they are available at runtime.
3066 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003067 *
3068 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3069 * for a non-Aarch64 build it will be silently ignored.
3070 *
3071 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3072 * of \c -march=armv8-a+crypto.
3073 *
3074 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3075 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3076 *
3077 * Requires: MBEDTLS_SHA256_C.
3078 *
3079 * Module: library/sha256.c
3080 *
3081 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3082 * and use them if available.
3083 */
3084//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3085
3086/**
3087 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3088 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003089 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3090 * with the ARMv8 cryptographic extensions, which must be available at runtime
3091 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003092 *
3093 * \note This allows builds with a smaller code size than with
3094 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3095 *
3096 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
3097 * of \c -march=armv8-a+crypto.
3098 *
3099 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3100 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3101 *
3102 * Requires: MBEDTLS_SHA256_C.
3103 *
3104 * Module: library/sha256.c
3105 *
3106 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3107 * unconditionally.
3108 */
3109//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3110
3111/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003112 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003113 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003114 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003115 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003116 * Requires: MBEDTLS_SHA512_C
3117 *
3118 * Module: library/sha512.c
3119 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003120 * library/psa_crypto_hash.c
3121 * library/ssl_tls.c
3122 * library/ssl*_client.c
3123 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003124 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003125 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003126 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003127#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003128
3129/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003130 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003131 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003132 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003133 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003134 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003135 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003136 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003137 * library/ssl_tls.c
3138 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003140 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003142#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003143
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003144/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003145 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3146 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003147 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3148 * with the ARMv8 cryptographic extensions if they are available at runtime.
3149 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003150 *
3151 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3152 * for a non-Aarch64 build it will be silently ignored.
3153 *
3154 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3155 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3156 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3157 * fastest code.
3158 *
3159 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3160 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3161 *
3162 * Requires: MBEDTLS_SHA512_C.
3163 *
3164 * Module: library/sha512.c
3165 *
3166 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3167 * and use them if available.
3168 */
3169//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3170
3171/**
3172 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3173 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003174 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3175 * with the ARMv8 cryptographic extensions, which must be available at runtime
3176 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003177 *
3178 * \note This allows builds with a smaller code size than with
3179 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3180 *
3181 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3182 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3183 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3184 * fastest code.
3185 *
3186 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3187 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3188 *
3189 * Requires: MBEDTLS_SHA512_C.
3190 *
3191 * Module: library/sha512.c
3192 *
3193 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3194 * unconditionally.
3195 */
3196//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3197
3198/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003200 *
3201 * Enable simple SSL cache implementation.
3202 *
3203 * Module: library/ssl_cache.c
3204 * Caller:
3205 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003209
3210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003212 *
3213 * Enable basic implementation of DTLS cookies for hello verification.
3214 *
3215 * Module: library/ssl_cookie.c
3216 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003217 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003219
3220/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003221 * \def MBEDTLS_SSL_TICKET_C
3222 *
3223 * Enable an implementation of TLS server-side callbacks for session tickets.
3224 *
3225 * Module: library/ssl_ticket.c
3226 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003227 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003228 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3229 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003230 */
3231#define MBEDTLS_SSL_TICKET_C
3232
3233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003235 *
3236 * Enable the SSL/TLS client code.
3237 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003238 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003239 * Caller:
3240 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003241 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003242 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003243 * This module is required for SSL/TLS client support.
3244 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003246
Paul Bakker9a736322012-11-14 12:39:52 +00003247/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003249 *
3250 * Enable the SSL/TLS server code.
3251 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003252 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003253 * Caller:
3254 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003256 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003257 * This module is required for SSL/TLS server support.
3258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003259#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003260
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003261/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003263 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003264 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003265 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003266 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003267 * Caller: library/ssl*_client.c
3268 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003269 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003270 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3271 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003272 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003273 * This module is required for SSL/TLS.
3274 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003275#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003276
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003277/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003279 *
3280 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003281 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003282 * contexts are not shared between threads. If you do intend to use contexts
3283 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003284 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003285 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003286 *
3287 * Module: library/threading.c
3288 *
3289 * This allows different threading implementations (self-implemented or
3290 * provided).
3291 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292 * You will have to enable either MBEDTLS_THREADING_ALT or
3293 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003294 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003295 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003298
3299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003300 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003301 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003302 * Enable the semi-portable timing interface.
3303 *
Simon Butcherd567a232016-03-09 20:19:21 +00003304 * \note The provided implementation only works on POSIX/Unix (including Linux,
3305 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003306 * module and provide your own implementations of the callbacks needed by
3307 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3308 * your own implementation of the whole module by setting
3309 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003310 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003311 * \note The timing module will include time.h on suitable platforms
3312 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3313 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3314 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003315 * \note See also our Knowledge Base article about porting to a new
3316 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003317 * 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 +00003318 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003319 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003321#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003322
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003325 *
3326 * Enable run-time version information.
3327 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003328 * Module: library/version.c
3329 *
3330 * This module provides run-time version information.
3331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003333
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003334/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003336 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003337 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003338 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003339 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003340 * Caller: library/x509_crl.c
3341 * library/x509_crt.c
3342 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003344 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003345 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3346 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003347 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3348 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003349 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003350 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003353
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003354/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003356 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003357 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003358 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003359 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003360 * Caller: library/ssl_tls.c
3361 * library/ssl*_client.c
3362 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003363 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003364 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003365 *
3366 * This module is required for X.509 certificate parsing.
3367 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003368#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003369
3370/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003372 *
3373 * Enable X.509 CRL parsing.
3374 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003375 * Module: library/x509_crl.c
3376 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003377 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003379 *
3380 * This module is required for X.509 CRL parsing.
3381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003383
3384/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003386 *
3387 * Enable X.509 Certificate Signing Request (CSR) parsing.
3388 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003389 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003390 * Caller: library/x509_crt_write.c
3391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003393 *
3394 * This module is used for reading X.509 certificate request.
3395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003397
3398/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003400 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003401 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003402 *
3403 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003404 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003405 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003406 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3407 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003408 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3409 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003410 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003411 * This module is the basis for creating X.509 certificates and CSRs.
3412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003414
3415/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003417 *
3418 * Enable creating X.509 certificates.
3419 *
3420 * Module: library/x509_crt_write.c
3421 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003423 *
3424 * This module is required for X.509 certificate creation.
3425 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003427
3428/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003429 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003430 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003431 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003432 *
3433 * Module: library/x509_csr_write.c
3434 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003436 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003437 * This module is required for X.509 certificate request writing.
3438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003439#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003440
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003441/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003442
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003443/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003444 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003445 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003446 * This section contains Mbed TLS build settings that are not associated
3447 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003448 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003449 * \{
3450 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003451
Gilles Peskinea02c1242022-03-16 17:03:19 +01003452/**
3453 * \def MBEDTLS_CONFIG_FILE
3454 *
3455 * If defined, this is a header which will be included instead of
3456 * `"mbedtls/mbedtls_config.h"`.
3457 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003458 * Unlike other configuration options, this one must be defined on the
3459 * compiler command line: a definition in `mbedtls_config.h` would have
3460 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003461 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003462 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003463 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003464 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003465 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003466 * The value of this symbol is typically a path in double quotes, either
3467 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003468 */
3469//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3470
3471/**
3472 * \def MBEDTLS_USER_CONFIG_FILE
3473 *
3474 * If defined, this is a header which will be included after
3475 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003476 * This allows you to modify the default configuration, including the ability
3477 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003478 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003479 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003480 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003481 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003482 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003483 * The value of this symbol is typically a path in double quotes, either
3484 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003485 */
3486//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3487
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003488/**
3489 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3490 *
3491 * If defined, this is a header which will be included instead of
3492 * `"psa/crypto_config.h"`.
3493 * This header file specifies which cryptographic mechanisms are available
3494 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3495 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3496 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003497 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003498 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003499 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003500 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003501 * The value of this symbol is typically a path in double quotes, either
3502 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003503 */
3504//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3505
3506/**
3507 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3508 *
3509 * If defined, this is a header which will be included after
3510 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003511 * This allows you to modify the default configuration, including the ability
3512 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003513 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003514 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003515 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003516 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003517 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003518 * The value of this symbol is typically a path in double quotes, either
3519 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003520 */
3521//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3522
Gilles Peskineba4162a2022-04-11 17:04:38 +02003523/** \} name SECTION: General configuration options */
3524
3525/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003526 * \name SECTION: Module configuration options
3527 *
3528 * This section allows for the setting of module specific sizes and
3529 * configuration options. The default values are already present in the
3530 * relevant header files and should suffice for the regular use cases.
3531 *
3532 * Our advice is to enable options and change their values here
3533 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003534 * \{
3535 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003536/* The Doxygen documentation here is used when a user comments out a
3537 * setting and runs doxygen themselves. On the other hand, when we typeset
3538 * the full documentation including disabled settings, the documentation
3539 * in specific modules' header files is used if present. When editing this
3540 * file, make sure that each option is documented in exactly one place,
3541 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3542 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003543
Paul Bakker088c5c52014-04-25 11:11:10 +02003544/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003545//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003547
Paul Bakker088c5c52014-04-25 11:11:10 +02003548/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003549//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3550//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3551//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3552//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3553//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003554
Paul Bakker088c5c52014-04-25 11:11:10 +02003555/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3557//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3558//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3559//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003560
Paul Bakker088c5c52014-04-25 11:11:10 +02003561/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003562//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003563//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003564
Paul Bakker088c5c52014-04-25 11:11:10 +02003565/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003566//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3567//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003568//#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 +01003569
Paul Bakker088c5c52014-04-25 11:11:10 +02003570/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003572
Paul Bakker088c5c52014-04-25 11:11:10 +02003573/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574//#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 +02003575//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003577//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003578//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003579//#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 +02003580//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3581//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003582/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003584//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3585//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003586//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3587//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3588//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003589
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003590/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3591/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003592//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3594//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003595//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003596//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3597//#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 +02003598//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3599//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003600/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003602//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003603//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3604//#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 +02003605
Gilles Peskine3f106f72021-09-23 17:42:39 +02003606/** \def MBEDTLS_CHECK_RETURN
3607 *
3608 * This macro is used at the beginning of the declaration of a function
3609 * to indicate that its return value should be checked. It should
3610 * instruct the compiler to emit a warning or an error if the function
3611 * is called without checking its return value.
3612 *
3613 * There is a default implementation for popular compilers in platform_util.h.
3614 * You can override the default implementation by defining your own here.
3615 *
3616 * If the implementation here is empty, this will effectively disable the
3617 * checking of functions' return values.
3618 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003619//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003620
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003621/** \def MBEDTLS_IGNORE_RETURN
3622 *
3623 * This macro requires one argument, which should be a C function call.
3624 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3625 * warning is suppressed.
3626 */
3627//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3628
Gilles Peskineed038902020-11-13 21:33:21 +01003629/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003630/**
Gilles Peskineed038902020-11-13 21:33:21 +01003631 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3632 * PSA crypto subsystem.
3633 *
3634 * If this option is unset:
3635 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003636 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003637 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3638 * on unspecified heuristics.
3639 */
3640//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3641
Steven Cooreman863470a2021-02-15 14:03:19 +01003642/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003643 * Restrict the PSA library to supporting a maximum amount of simultaneously
3644 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3645 * volatile key, or a persistent key which is loaded temporarily by the
3646 * library as part of a crypto operation in flight.
3647 *
3648 * If this option is unset, the library will fall back to a default value of
3649 * 32 keys.
3650 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003651//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003652
Paul Bakker088c5c52014-04-25 11:11:10 +02003653/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003654//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3655//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003656
Paul Bakker088c5c52014-04-25 11:11:10 +02003657/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003658
Angus Grattond8213d02016-05-25 20:56:48 +10003659/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3660 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003661 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003662 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003663 * This determines the size of the incoming TLS I/O buffer in such a way
3664 * that it is capable of holding the specified amount of plaintext data,
3665 * regardless of the protection mechanism used.
3666 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003667 * \note When using a value less than the default of 16KB on the client, it is
3668 * recommended to use the Maximum Fragment Length (MFL) extension to
3669 * inform the server about this limitation. On the server, there
3670 * is no supported, standardized way of informing the client about
3671 * restriction on the maximum size of incoming messages, and unless
3672 * the limitation has been communicated by other means, it is recommended
3673 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3674 * while keeping the default value of 16KB for the incoming buffer.
3675 *
David Horstmann95d516f2021-05-04 18:36:56 +01003676 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003677 */
3678//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3679
Gilles Peskined3d02902020-03-04 21:35:27 +01003680/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3681 *
3682 * The maximum length of CIDs used for incoming DTLS messages.
3683 *
3684 */
3685//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3686
3687/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3688 *
3689 * The maximum length of CIDs used for outgoing DTLS messages.
3690 *
3691 */
3692//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3693
TRodziewicze8dd7092021-05-12 14:19:11 +02003694/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003695 *
3696 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003697 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003698 *
3699 * The padding will always be chosen so that the length of the
3700 * padded plaintext is a multiple of the value of this option.
3701 *
3702 * Note: A value of \c 1 means that no padding will be used
3703 * for outgoing records.
3704 *
3705 * Note: On systems lacking division instructions,
3706 * a power of two should be preferred.
3707 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003708//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003709
Angus Grattond8213d02016-05-25 20:56:48 +10003710/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3711 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003712 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003713 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003714 * This determines the size of the outgoing TLS I/O buffer in such a way
3715 * that it is capable of holding the specified amount of plaintext data,
3716 * regardless of the protection mechanism used.
3717 *
Angus Grattond8213d02016-05-25 20:56:48 +10003718 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3719 * the default inward 16384 byte buffer to conform to the TLS specification.
3720 *
3721 * The minimum required outward buffer size is determined by the handshake
3722 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3723 * The specific size requirement depends on the configured ciphers and any
3724 * certificate data which is sent during the handshake.
3725 *
David Horstmann95d516f2021-05-04 18:36:56 +01003726 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003727 */
3728//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3729
Hanno Beckere0b150f2018-08-21 15:51:03 +01003730/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3731 *
3732 * Maximum number of heap-allocated bytes for the purpose of
3733 * DTLS handshake message reassembly and future message buffering.
3734 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003735 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003736 * to account for a reassembled handshake message of maximum size,
3737 * together with its reassembly bitmap.
3738 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003739 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003740 * should be sufficient for all practical situations as it allows
3741 * to reassembly a large handshake message (such as a certificate)
3742 * while buffering multiple smaller handshake messages.
3743 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003744 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003745//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003746
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003747//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3748//#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 +02003749
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003750/**
3751 * Complete list of ciphersuites to use, in order of preference.
3752 *
3753 * \warning No dependency checking is done on that field! This option can only
3754 * be used to restrict the set of available ciphersuites. It is your
3755 * responsibility to make sure the needed modules are active.
3756 *
3757 * Use this to save a few hundred bytes of ROM (default ordering of all
3758 * available ciphersuites) and a few to a few hundred bytes of RAM.
3759 *
3760 * The value below is only an example, not the default.
3761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003762//#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 +02003763
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003764/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003765//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003766//#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 +01003767
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003768/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003769 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003770 * mbedtls_platform_zeroize(). This replaces the default implementation in
3771 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003772 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003773 * mbedtls_platform_zeroize() is a widely used function across the library to
3774 * zero a block of memory. The implementation is expected to be secure in the
3775 * sense that it has been written to prevent the compiler from removing calls
3776 * to mbedtls_platform_zeroize() as part of redundant code elimination
3777 * optimizations. However, it is difficult to guarantee that calls to
3778 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3779 * versions of the C language standards do not provide a secure implementation
3780 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3781 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003782 * example by using directives specific to their compiler, features from newer
3783 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003784 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003785 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003786//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003787
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003788/**
3789 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003790 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003791 * platform_util.c.
3792 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003793 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003794 * library will try to use safer implementations of this function, such as
3795 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003796 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003797 * using the standard gmtime(). In this case, calls from the library to
3798 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003799 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003800 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003801 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3802 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3803 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003804 */
Hanno Becker6a739782018-09-05 15:06:19 +01003805//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003806
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003807/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003808 * Enable the verified implementations of ECDH primitives from Project Everest
3809 * (currently only Curve25519). This feature changes the layout of ECDH
3810 * contexts and therefore is a compatibility break for applications that access
3811 * fields of a mbedtls_ecdh_context structure directly. See also
3812 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003813 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003814//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003815
Gilles Peskine611179c2022-04-13 23:04:48 +02003816/** \} name SECTION: Module configuration options */