blob: dcd28e9c42cbf6bb83a04130977ba14ff1faf84d [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:
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000051 * library/aesni.h
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010052 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000053 * library/bn_mul.h
Dave Rodgmancb0f2c42022-12-23 13:15:37 +000054 * library/constant_time.c
55 * library/padlock.h
Paul Bakker68041ec2009-04-19 21:17:55 +000056 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010057 * Required by:
Tom Cosgrovef586aa22023-03-20 14:45:27 +000058 * MBEDTLS_AESCE_C
Gilles Peskine0bfccfa2023-03-16 17:49:44 +010059 * MBEDTLS_AESNI_C (on some platforms)
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010060 * MBEDTLS_PADLOCK_C
61 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020062 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000065
Paul Bakkerf3b86c12011-01-27 15:24:17 +000066/**
Gilles Peskineed942f82017-06-08 15:19:20 +020067 * \def MBEDTLS_NO_UDBL_DIVISION
68 *
69 * The platform lacks support for double-width integer division (64-bit
70 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
71 *
72 * Used in:
73 * include/mbedtls/bignum.h
74 * library/bignum.c
75 *
76 * The bignum code uses double-width division to speed up some operations.
77 * Double-width division is often implemented in software that needs to
78 * be linked with the program. The presence of a double-width integer
79 * type is usually detected automatically through preprocessor macros,
80 * but the automatic detection cannot know whether the code needs to
81 * and can be linked with an implementation of division for that type.
82 * By default division is assumed to be usable if the type is present.
83 * Uncomment this option to prevent the use of double-width division.
84 *
85 * Note that division for the native integer type is always required.
86 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010087 * platform, but it need not support multiplication or division. In some
88 * cases it is also desirable to disable some double-width operations. For
89 * example, if double-width division is implemented in software, disabling
90 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020091 */
92//#define MBEDTLS_NO_UDBL_DIVISION
93
94/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020095 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
96 *
97 * The platform lacks support for 32x32 -> 64-bit multiplication.
98 *
99 * Used in:
100 * library/poly1305.c
101 *
102 * Some parts of the library may use multiplication of two unsigned 32-bit
103 * operands with a 64-bit result in order to speed up computations. On some
104 * platforms, this is not available in hardware and has to be implemented in
105 * software, usually in a library provided by the toolchain.
106 *
107 * Sometimes it is not desirable to have to link to that library. This option
108 * removes the dependency of that library on platforms that lack a hardware
109 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
110 *
111 * Note that depending on the compiler, this may decrease performance compared
112 * to using the library function provided by the toolchain.
113 */
114//#define MBEDTLS_NO_64BIT_MULTIPLICATION
115
116/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200117 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000118 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000119 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000120 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000121 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200124
125/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200128 * System has time.h and time().
129 * The time does not need to be correct, only time differences are used,
130 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200131 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100132 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
133 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
134 * MBEDTLS_PLATFORM_STD_TIME.
135 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400136 * Comment if your system does not support time functions.
137 *
138 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
139 * interface - timing.c will include time.h on suitable platforms
140 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
141 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200142 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200143#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100144
145/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200146 * \def MBEDTLS_HAVE_TIME_DATE
147 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100148 * System has time.h, time(), and an implementation for
149 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100150 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200151 * the date should be correct). This is used to verify the validity period of
152 * X.509 certificates.
153 *
154 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100155 *
Hanno Becker6a739782018-09-05 15:06:19 +0100156 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100157 * behaves similarly to the gmtime_r() function from the C standard. Refer to
158 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100159 *
160 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100161 * mbedtls_platform_gmtime_r() at compile-time by using the macro
162 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200163 */
164#define MBEDTLS_HAVE_TIME_DATE
165
166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 *
169 * Enable the memory allocation layer.
170 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200171 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100172 * This allows different allocators (self-implemented or provided) to be
173 * provided to the platform abstraction layer.
174 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200176 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
177 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * free() function pointer at runtime.
179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200181 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000182 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100183 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185 *
186 * Enable this layer to allow use of alternative memory allocators.
187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100189
190/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200192 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200193 * Do not assign standard functions in the platform layer (e.g. calloc() to
194 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200195 *
196 * This makes sure there are no linking errors on platforms that do not support
197 * these functions. You will HAVE to provide alternatives, either at runtime
198 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
200 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200201 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200202 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200203 *
204 * Uncomment to prevent default assignment of standard functions in the
205 * platform layer.
206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200208
209/**
Janos Follathc351d182016-03-21 08:43:59 +0000210 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100211 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100212 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
213 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
216 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100217 * alternative printf function pointer.
218 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100220 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200221 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
222 * it will be enabled automatically by check_config.h
223 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200224 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000226 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100227 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
228 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100229 * Uncomment a macro to enable alternate implementation of specific base
230 * platform function
231 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200232//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100234//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200235//#define MBEDTLS_PLATFORM_FPRINTF_ALT
236//#define MBEDTLS_PLATFORM_PRINTF_ALT
237//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200238//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100239//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100240//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Jerry Yu38257492022-12-15 17:54:47 +0800241//#define MBEDTLS_PLATFORM_MS_TIME_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100242
243/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000246 * Mark deprecated functions and features so that they generate a warning if
247 * used. Functionality deprecated in one version will usually be removed in the
248 * next version. You can enable this to help you prepare the transition to a
249 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 *
251 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100253 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000254 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100257
258/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000261 * Remove deprecated functions and features so that they generate an error if
262 * used. Functionality deprecated in one version will usually be removed in the
263 * next version. You can enable this to help you prepare the transition to a
264 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100265 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000266 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100269
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100270/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000271
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000272/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000273 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000274 *
275 * This section sets support for features that are or are not needed
276 * within the modules that are enabled.
277 * \{
278 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000279
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000280/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100282 *
TRodziewiczd8540832021-06-10 15:16:50 +0200283 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200284 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100285 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100287 *
288 * You will need to provide a header "timing_alt.h" and an implementation at
289 * compile time.
290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100292
293/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100294 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200295 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100296 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100297 * alternate core implementation of a symmetric crypto, an arithmetic or hash
298 * module (e.g. platform specific assembly optimized implementations). Keep
299 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200300 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200301 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200303 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000305 * provide the "struct mbedtls_aes_context" definition and omit the base
306 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200307 * "aes.h" to include the new function definitions.
308 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200309 * Uncomment a macro to enable alternate implementation of the corresponding
310 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100311 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200312 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100313 * use constitutes a security risk. If possible, we recommend
314 * avoiding dependencies on them, and considering stronger message
315 * digests and ciphers instead.
316 *
Paul Bakker90995b52013-06-24 19:20:35 +0200317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000319//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200321//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300322//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200323//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200324//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000326//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000327//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100328//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300329//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300331//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000333//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334//#define MBEDTLS_SHA1_ALT
335//#define MBEDTLS_SHA256_ALT
336//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000337
Janos Follathb0697532016-08-18 12:38:46 +0100338/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800339 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100340 * implemented with two .c files:
341 * - ecp.c
342 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000343 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
344 * macros as described above. The only difference is that you have to make sure
345 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100346 */
347//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200348
349/**
TRodziewicz75628d52021-06-18 12:56:27 +0200350 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200351 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100352 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
353 * alternate core implementation of symmetric crypto or hash function. Keep in
354 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200355 *
356 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
360 * no longer provide the mbedtls_sha1_process() function, but it will still provide
361 * the other function (using your mbedtls_sha1_process() function) and the definition
362 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200363 * with this definition.
364 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200365 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100366 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
367 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200368 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200369 * Uncomment a macro to enable alternate implementation of the corresponding
370 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100371 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200372 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100373 * constitutes a security risk. If possible, we recommend avoiding
374 * dependencies on them, and considering stronger message digests
375 * and ciphers instead.
376 *
Janos Follath1231d212019-01-07 15:01:32 +0000377 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
378 * enabled, then the deterministic ECDH signature functions pass the
379 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
380 * alternative implementations should use the RNG only for generating
381 * the ephemeral key and nothing else. If this is not possible, then
382 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200383 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000384 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386//#define MBEDTLS_MD5_PROCESS_ALT
387//#define MBEDTLS_RIPEMD160_PROCESS_ALT
388//#define MBEDTLS_SHA1_PROCESS_ALT
389//#define MBEDTLS_SHA256_PROCESS_ALT
390//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200391//#define MBEDTLS_DES_SETKEY_ALT
392//#define MBEDTLS_DES_CRYPT_ECB_ALT
393//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200394//#define MBEDTLS_AES_SETKEY_ENC_ALT
395//#define MBEDTLS_AES_SETKEY_DEC_ALT
396//#define MBEDTLS_AES_ENCRYPT_ALT
397//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300398//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300399//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300400//#define MBEDTLS_ECDSA_VERIFY_ALT
401//#define MBEDTLS_ECDSA_SIGN_ALT
402//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200403
404/**
Janos Follathc44ab972016-11-18 16:38:23 +0000405 * \def MBEDTLS_ECP_INTERNAL_ALT
406 *
407 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100408 *
409 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100410 * alternative core implementation of elliptic curve arithmetic. Keep in mind
411 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100412 *
413 * This partially replaces one function. The header file from mbed TLS is still
414 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
415 * is still present and it is used for group structures not supported by the
416 * alternative.
417 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100418 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100419 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100420 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
421 * able to fallback to curves not supported by the alternative implementation.
422 *
Janos Follathc44ab972016-11-18 16:38:23 +0000423 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
424 * and implementing the following functions:
425 * unsigned char mbedtls_internal_ecp_grp_capable(
426 * const mbedtls_ecp_group *grp )
427 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500428 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000429 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
430 * replacement functions implement arithmetic for the given group and 0
431 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500432 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000433 * called before and after each point operation and provide an opportunity to
434 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100435 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100436 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
437 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
438 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
439 * for the operation is supported by your implementation (i.e. your
440 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
441 * group is not supported by your implementation, then the original mbed TLS
442 * implementation of ecp_double_jac() is used instead, unless this fallback
443 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
444 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
445 *
446 * The function prototypes and the definition of mbedtls_ecp_group and
447 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
448 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
449 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100450 *
451 * Uncomment a macro to enable alternate implementation of the corresponding
452 * function.
453 */
454/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000455//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100456/* Turn off software fallback for curves not supported in hardware */
457//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100458/* Support for Weierstrass curves with Jacobi representation */
459//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
460//#define MBEDTLS_ECP_ADD_MIXED_ALT
461//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
462//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
463//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
464/* Support for curves with Montgomery arithmetic */
465//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
466//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
467//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
468
469/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200470 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200471 *
472 * Uncomment this macro to let mbed TLS use your own implementation of a
473 * hardware entropy collector.
474 *
475 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000476 * prototype as declared in library/entropy_poll.h, and accept NULL as first
477 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200478 *
479 * Uncomment to use your own hardware entropy collector.
480 */
481//#define MBEDTLS_ENTROPY_HARDWARE_ALT
482
483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000485 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100486 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000487 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100488 * Uncomment this macro to use precomputed AES tables stored in ROM.
489 * Comment this macro to generate AES tables in RAM at runtime.
490 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100491 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
492 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100493 * initialization time before the first AES operation can be performed.
494 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
495 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
496 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100497 *
498 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
Paul Bakker15566e42011-04-24 21:19:15 +0000499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200500//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000501
502/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100503 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200504 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100505 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200506 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100507 * Uncommenting this macro omits 75% of the AES tables from
508 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
509 * by computing their values on the fly during operations
510 * (the tables are entry-wise rotations of one another).
511 *
512 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100513 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100514 * runtime. Specifically, one has to compare 4 accesses within
515 * different tables to 4 accesses with additional arithmetic
516 * operations within the same table. The performance gain/loss
517 * depends on the system and memory details.
518 *
519 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200520 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100521//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200522
523/**
Arto Kinnunen732ca322023-04-14 14:26:10 +0800524 * \def MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
525 *
526 * Use only 128-bit keys in AES operations to save ROM.
527 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800528 * Uncomment this macro to remove support for AES operations that use 192-
Arto Kinnunen732ca322023-04-14 14:26:10 +0800529 * or 256-bit keys.
530 *
Yanray Wangd2ae4322023-05-10 10:45:38 +0800531 * Uncommenting this macro reduces the size of AES code by ~300 bytes
532 * on v8-M/Thumb2.
Arto Kinnunen732ca322023-04-14 14:26:10 +0800533 *
Arto Kinnunen732ca322023-04-14 14:26:10 +0800534 * Module: library/aes.c
535 *
536 * Requires: MBEDTLS_AES_C
Arto Kinnunen732ca322023-04-14 14:26:10 +0800537 */
538//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
539
540/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200541 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200542 *
543 * Use less ROM for the Camellia implementation (saves about 768 bytes).
544 *
545 * Uncomment this macro to use less memory for Camellia.
546 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200547//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200548
549/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200550 * \def MBEDTLS_CHECK_RETURN_WARNING
551 *
552 * If this macro is defined, emit a compile-time warning if application code
553 * calls a function without checking its return value, but the return value
554 * should generally be checked in portable applications.
555 *
556 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
557 * implemented. Otherwise this option has no effect.
558 *
559 * Uncomment to get warnings on using fallible functions without checking
560 * their return value.
561 *
562 * \note This feature is a work in progress.
563 * Warnings will be added to more functions in the future.
564 *
565 * \note A few functions are considered critical, and ignoring the return
566 * value of these functions will trigger a warning even if this
567 * macro is not defined. To completely disable return value check
568 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
569 */
570//#define MBEDTLS_CHECK_RETURN_WARNING
571
572/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200574 *
575 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
576 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200578
579/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000581 *
582 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000585
586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000588 *
589 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000592
593/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100594 * \def MBEDTLS_CIPHER_MODE_OFB
595 *
596 * Enable Output Feedback mode (OFB) for symmetric ciphers.
597 */
598#define MBEDTLS_CIPHER_MODE_OFB
599
600/**
601 * \def MBEDTLS_CIPHER_MODE_XTS
602 *
603 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
604 */
605#define MBEDTLS_CIPHER_MODE_XTS
606
607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200608 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000609 *
610 * Enable NULL cipher.
611 * Warning: Only do so when you know what you are doing. This allows for
612 * encryption or channels without any security!
613 *
Ronald Croncee42702021-04-26 11:34:44 +0200614 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
616 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
617 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
618 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
619 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
620 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
621 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
622 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
623 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
624 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
625 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
626 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
627 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
628 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
629 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
630 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
631 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
632 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
633 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000634 *
635 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200637//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000638
639/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100640 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200641 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100642 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
643 * specific padding modes in the cipher layer with cipher modes that support
644 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200645 *
646 * If you disable all padding modes, only full blocks can be used with CBC.
647 *
648 * Enable padding modes in the cipher layer.
649 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#define MBEDTLS_CIPHER_PADDING_PKCS7
651#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
652#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
653#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200654
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200655/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
656 *
657 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
Yanray Wang55ef22c2023-06-15 09:57:06 +0800658 * Without this, CTR_DRBG uses a 256-bit key
659 * unless \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200660 */
661//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
662
Paul Bakker48e93c82013-08-14 12:21:18 +0200663/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100664 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200665 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100666 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
667 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200668 *
669 * Comment macros to disable the curve and functions for it
670 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200671/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
673#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
674#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
675#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
676#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
677#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
678#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
679#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
680#define MBEDTLS_ECP_DP_BP256R1_ENABLED
681#define MBEDTLS_ECP_DP_BP384R1_ENABLED
682#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200683/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200684#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000685#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200686
687/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200689 *
690 * Enable specific 'modulo p' routines for each NIST prime.
691 * Depending on the prime and architecture, makes operations 4 to 8 times
692 * faster on the corresponding curve.
693 *
694 * Comment this macro to disable NIST curves optimisation.
695 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200696#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200697
698/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200699 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100700 *
701 * Enable "non-blocking" ECC operations that can return early and be resumed.
702 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200703 * This allows various functions to pause by returning
704 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
705 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
706 * order to further progress and eventually complete their operation. This is
707 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
708 * number of ECC operations a function may perform before pausing; see
709 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100710 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200711 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200712 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100713 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100714 * This option:
715 * - Adds xxx_restartable() variants of existing operations in the
716 * following modules, with corresponding restart context types:
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100717 * - ECP (for Short Weierstrass curves only): scalar multiplication (mul),
718 * linear combination (muladd);
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100719 * - ECDSA: signature generation & verification;
720 * - PK: signature generation & verification;
721 * - X509: certificate chain verification.
722 * - Adds mbedtls_ecdh_enable_restart() in the ECDH module.
723 * - Changes the behaviour of TLS 1.2 clients (not servers) when using the
724 * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC
725 * computations restartable:
Tom Cosgrove5c8505f2023-03-07 11:39:52 +0000726 * - ECDH operations from the key exchange, only for Short Weierstrass
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100727 * curves, only when MBEDTLS_USE_PSA_CRYPTO is not enabled.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100728 * - verification of the server's key exchange signature;
729 * - verification of the server's certificate chain;
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100730 * - generation of the client's signature if client authentication is used,
731 * with an ECC key/certificate.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100732 *
733 * \note In the cases above, the usual SSL/TLS functions, such as
734 * mbedtls_ssl_handshake(), can now return
735 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200736 *
Manuel Pégourié-Gonnard55a188b2022-12-06 12:00:33 +0100737 * \note When this option and MBEDTLS_USE_PSA_CRYPTO are both enabled,
738 * restartable operations in PK, X.509 and TLS (see above) are not
739 * using PSA. On the other hand, ECDH computations in TLS are using
Manuel Pégourié-Gonnardb2812cc2022-12-09 09:53:55 +0100740 * PSA, and are not restartable. These are temporary limitations that
741 * should be lifted in the future.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200742 *
Ron Eldor19779c42018-11-05 16:58:13 +0200743 * \note This option only works with the default software implementation of
744 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100745 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100746 *
Manuel Pégourié-Gonnardad45c4d2022-12-06 13:20:06 +0100747 * Requires: MBEDTLS_ECP_C
748 *
Manuel Pégourié-Gonnard2b7ad642022-12-06 10:42:44 +0100749 * Uncomment this macro to enable restartable ECC computations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100750 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200751//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100752
753/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200754 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100755 *
756 * Enable deterministic ECDSA (RFC 6979).
757 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
758 * may result in a compromise of the long-term signing key. This is avoided by
759 * the deterministic variant.
760 *
John Durkop36a82e52020-10-26 09:39:05 -0700761 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100762 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100763 * Comment this macro to disable deterministic ECDSA.
764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100766
767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200769 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200770 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200771 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200772 * This enables the following ciphersuites (if other requisites are
773 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200774 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
775 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
776 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
777 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
778 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
779 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
780 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
781 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
782 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
783 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200784 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200786
787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200788 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200790 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200793 *
794 * This enables the following ciphersuites (if other requisites are
795 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200796 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
797 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
798 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
799 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
800 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
801 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
802 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
803 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
804 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
805 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100806 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100807 * \warning Using DHE constitutes a security risk as it
808 * is not possible to validate custom DH parameters.
809 * If possible, it is recommended users should consider
810 * preferring other methods of key exchange.
811 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100812 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200815
816/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200817 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200818 *
819 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
820 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200821 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200822 *
823 * This enables the following ciphersuites (if other requisites are
824 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200825 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
826 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
827 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
828 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
829 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
830 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200831 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200832#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200833
834/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200836 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200837 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +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_PSK_WITH_AES_256_GCM_SHA384
845 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
846 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
847 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
848 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
849 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
850 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
851 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
852 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
853 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200856
857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200860 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
863 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
865 * This enables the following ciphersuites (if other requisites are
866 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
868 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
869 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
870 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
871 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
872 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
873 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
874 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
875 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
876 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
877 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
878 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200880#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200881
882/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200885 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200886 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200887 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
888 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200889 *
890 * This enables the following ciphersuites (if other requisites are
891 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200892 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
893 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
894 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
895 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
896 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
897 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
898 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
899 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
900 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
901 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
902 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
903 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100904 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100905 * \warning Using DHE constitutes a security risk as it
906 * is not possible to validate custom DH parameters.
907 * If possible, it is recommended users should consider
908 * preferring other methods of key exchange.
909 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100910 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200911 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200912#define MBEDTLS_KEY_EXCHANGE_DHE_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_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200916 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200917 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200918 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200919 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
920 * MBEDTLS_RSA_C
921 * MBEDTLS_PKCS1_V15
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200922 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200923 *
924 * This enables the following ciphersuites (if other requisites are
925 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200926 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
927 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
928 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
929 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
930 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
931 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
932 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
933 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
934 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
935 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200937#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200938
939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200942 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200943 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200944 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
945 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
946 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200947 *
948 * This enables the following ciphersuites (if other requisites are
949 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
951 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
952 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
953 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
954 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
955 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
956 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
957 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
958 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
959 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200960 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200962
963/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200964 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100965 *
966 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
967 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200968 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
969 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
970 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100971 *
972 * This enables the following ciphersuites (if other requisites are
973 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
975 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
976 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
977 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
978 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
979 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
980 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
981 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
982 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
983 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100986
987/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200988 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100989 *
990 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
991 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +0200992 * Requires: MBEDTLS_ECDH_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDH)
993 * MBEDTLS_RSA_C
994 * MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100995 *
996 * This enables the following ciphersuites (if other requisites are
997 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
999 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1000 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1001 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1002 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1003 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1004 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1005 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1006 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1007 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +01001010
1011/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001012 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
1013 *
1014 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
1015 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001016 * \warning This is currently experimental. EC J-PAKE support is based on the
1017 * Thread v1.0.0 specification; incompatible changes to the specification
1018 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001019 *
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001020 * Requires: MBEDTLS_ECJPAKE_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_JPAKE)
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001021 * SHA-256 (via MBEDTLS_SHA256_C or a PSA driver)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001022 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
1023 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01001024 * \warning If SHA-256 is provided only by a PSA driver, you must call
1025 * psa_crypto_init() before the first hanshake (even if
1026 * MBEDTLS_USE_PSA_CRYPTO is disabled).
1027 *
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001028 * This enables the following ciphersuites (if other requisites are
1029 * enabled as well):
1030 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
1031 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +02001032//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +02001033
1034/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001036 *
1037 * Enhance support for reading EC keys using variants of SEC1 not allowed by
1038 * RFC 5915 and RFC 5480.
1039 *
1040 * Currently this means parsing the SpecifiedECDomain choice of EC
1041 * parameters (only known groups are supported, not arbitrary domains, to
1042 * avoid validation issues).
1043 *
1044 * Disable if you only need to support RFC 5915 + 5480 key formats.
1045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001046#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +01001047
1048/**
Valerio Settiaddeee42023-06-14 10:46:55 +02001049 * \def MBEDTLS_PK_PARSE_EC_COMPRESSED
1050 *
1051 * Enable the support for parsing public keys of type Short Weierstrass
1052 * (MBEDTLS_ECP_DP_SECP_XXX and MBEDTLS_ECP_DP_BP_XXX) which are using the
Valerio Setti3cd4ef72023-06-19 11:35:10 +02001053 * compressed point format. This parsing is done through ECP module's functions.
1054 *
1055 * \note As explained in the description of MBEDTLS_ECP_PF_COMPRESSED (in ecp.h)
1056 * the only unsupported curves are MBEDTLS_ECP_DP_SECP224R1 and
1057 * MBEDTLS_ECP_DP_SECP224K1.
Valerio Settiaddeee42023-06-14 10:46:55 +02001058 */
1059#define MBEDTLS_PK_PARSE_EC_COMPRESSED
1060
1061/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001062 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001063 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 * Enable a dummy error function to make use of mbedtls_strerror() in
1065 * third party libraries easier when MBEDTLS_ERROR_C is disabled
1066 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +02001067 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001068 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
1069 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001070 *
1071 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001072 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001074#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +01001075
1076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001077 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001078 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001079 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001080 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001081 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001084
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001085/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001087 *
1088 * Enable functions that use the filesystem.
1089 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001090#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001091
1092/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001094 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001095 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001096 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001097 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001098 * application.
1099 *
1100 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001103
1104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001106 *
1107 * Do not use built-in platform entropy functions.
1108 * This is useful if your platform does not support
1109 * standards like the /dev/urandom or Windows CryptoAPI.
1110 *
1111 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001112 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001113//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001114
1115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001117 *
1118 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1119 * default SHA-512 based one (if both are available).
1120 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001122 *
1123 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1124 * if you have performance concerns.
1125 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 * This option is only useful if both MBEDTLS_SHA256_C and
1127 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001130
1131/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001132 * \def MBEDTLS_ENTROPY_NV_SEED
1133 *
1134 * Enable the non-volatile (NV) seed file-based entropy source.
1135 * (Also enables the NV seed read/write functions in the platform layer)
1136 *
1137 * This is crucial (if not required) on systems that do not have a
1138 * cryptographic entropy source (in hardware or kernel) available.
1139 *
1140 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1141 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001142 * \note The read/write functions that are used by the entropy source are
1143 * determined in the platform layer, and can be modified at runtime and/or
1144 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1145 *
1146 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001147 * with regular fopen(), please make sure you make a seedfile with the
1148 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1149 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001150 * and written to or you will get an entropy source error! The default
1151 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1152 * bytes from the file.
1153 *
1154 * \note The entropy collector will write to the seed file before entropy is
1155 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001156 */
1157//#define MBEDTLS_ENTROPY_NV_SEED
1158
Ronald Cron71016a92020-08-28 19:01:50 +02001159/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001160 *
Ronald Cron71016a92020-08-28 19:01:50 +02001161 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001162 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001163 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1164 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001165 *
1166 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001167 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001168 */
Ronald Cron71016a92020-08-28 19:01:50 +02001169//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001170
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001171/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001172 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001173 *
1174 * Enable debugging of buffer allocator memory issues. Automatically prints
1175 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1176 * function for 'debug output' of allocated memory.
1177 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001179 *
1180 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001182//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001183
1184/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001186 *
1187 * Include backtrace information with each allocated block.
1188 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001190 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001191 *
1192 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001193 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001195
1196/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001197 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001198 *
1199 * Support external private RSA keys (eg from a HSM) in the PK layer.
1200 *
1201 * Comment this macro to disable support for external private RSA keys.
1202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001204
1205/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001207 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001208 * Enable support for PKCS#1 v1.5 encoding.
1209 *
Manuel Pégourié-Gonnard98b91d42022-10-19 10:59:30 +02001210 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001211 *
Paul Bakker48377d92013-08-30 12:06:24 +02001212 * This enables support for PKCS#1 v1.5 operations.
1213 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001214#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001215
1216/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001217 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001218 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001219 * Enable support for PKCS#1 v2.1 encoding.
1220 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001221 * Requires: MBEDTLS_RSA_C
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001222 *
Manuel Pégourié-Gonnardfb8d90a2023-03-16 10:47:59 +01001223 * \warning If using a hash that is only provided by PSA drivers, you must
1224 * call psa_crypto_init() before doing any PKCS#1 v2.1 operation.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01001225 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001226 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1227 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001228#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001229
Steven Cooreman6801f082021-02-19 17:21:22 +01001230/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1231 *
1232 * Enable support for platform built-in keys. If you enable this feature,
1233 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1234 * See the documentation of that function for more information.
1235 *
1236 * Built-in keys are typically derived from a hardware unique key or
1237 * stored in a secure element.
1238 *
1239 * Requires: MBEDTLS_PSA_CRYPTO_C.
1240 *
1241 * \warning This interface is experimental and may change or be removed
1242 * without notice.
1243 */
1244//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1245
Ronald Cron3768ac12021-01-26 16:58:00 +01001246/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1247 *
1248 * Enable support for PSA crypto client.
1249 *
1250 * \note This option allows to include the code necessary for a PSA
1251 * crypto client when the PSA crypto implementation is not included in
1252 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1253 * code to set and get PSA key attributes.
1254 * The development of PSA drivers partially relying on the library to
1255 * fulfill the hardware gaps is another possible usage of this option.
1256 *
1257 * \warning This interface is experimental and may change or be removed
1258 * without notice.
1259 */
1260//#define MBEDTLS_PSA_CRYPTO_CLIENT
1261
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001262/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1263 *
1264 * Make the PSA Crypto module use an external random generator provided
1265 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1266 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001267 * \note This random generator must deliver random numbers with cryptographic
1268 * quality and high performance. It must supply unpredictable numbers
1269 * with a uniform distribution. The implementation of this function
1270 * is responsible for ensuring that the random generator is seeded
1271 * with sufficient entropy. If you have a hardware TRNG which is slow
1272 * or delivers non-uniform output, declare it as an entropy source
1273 * with mbedtls_entropy_add_source() instead of enabling this option.
1274 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001275 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001276 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1277 * and define a function called mbedtls_psa_external_get_random()
1278 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001279 * ```
1280 * psa_status_t mbedtls_psa_external_get_random(
1281 * mbedtls_psa_external_random_context_t *context,
1282 * uint8_t *output, size_t output_size, size_t *output_length);
1283 * );
1284 * ```
1285 * The \c context value is initialized to 0 before the first call.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05001286 * The function must fill the \c output buffer with \c output_size bytes
1287 * of random data and set \c *output_length to \c output_size.
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001288 *
1289 * Requires: MBEDTLS_PSA_CRYPTO_C
1290 *
1291 * \warning If you enable this option, code that uses the PSA cryptography
1292 * interface will not use any of the entropy sources set up for
1293 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1294 * enables.
1295 *
1296 * \note This option is experimental and may be removed without notice.
1297 */
1298//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1299
Paul Bakker9dcc3222011-03-08 14:16:06 +00001300/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001301 * \def MBEDTLS_PSA_CRYPTO_SPM
1302 *
1303 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1304 * Partition Manager) integration which separates the code into two parts: a
1305 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1306 * Environment).
1307 *
1308 * Module: library/psa_crypto.c
1309 * Requires: MBEDTLS_PSA_CRYPTO_C
1310 *
1311 */
1312//#define MBEDTLS_PSA_CRYPTO_SPM
1313
1314/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001315 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001316 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001317 * Enable support for entropy injection at first boot. This feature is
1318 * required on systems that do not have a built-in entropy source (TRNG).
1319 * This feature is currently not supported on systems that have a built-in
1320 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001321 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001322 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001323 *
1324 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001325//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001326
1327/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001329 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001330 * Do not use the Chinese Remainder Theorem
1331 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001332 *
1333 * Uncomment this macro to disable the use of CRT in RSA.
1334 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001336//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001337
1338/**
Waleed Elmelegy76336c32023-06-30 16:48:19 +01001339 * \def MBEDTLS_RSA_MIN_KEY_SIZE
1340 *
1341 * Minimum RSA key size allowed in bits.
1342 *
1343 * Minimum possible value is 128 bits.
1344 */
1345#define MBEDTLS_RSA_MIN_KEY_SIZE 1024
1346
1347/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001348 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001349 *
1350 * Enable the checkup functions (*_self_test).
1351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001353
1354/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001355 * \def MBEDTLS_SHA256_SMALLER
1356 *
1357 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1358 * lower performance.
1359 *
Adam Wolf039080f2019-09-10 09:53:08 -05001360 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001361 * performance and size. This version optimizes more aggressively for size at
1362 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1363 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1364 * 30%.
1365 *
1366 * Uncomment to enable the smaller implementation of SHA256.
1367 */
1368//#define MBEDTLS_SHA256_SMALLER
1369
1370/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001371 * \def MBEDTLS_SHA512_SMALLER
1372 *
1373 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1374 * lower performance.
1375 *
1376 * Uncomment to enable the smaller implementation of SHA512.
1377 */
1378//#define MBEDTLS_SHA512_SMALLER
1379
1380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001382 *
1383 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001384 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001385 * with other servers, only debugging of failures is harder.
1386 *
1387 * The advantage of not sending alert messages, is that no information is given
1388 * about reasons for failures thus preventing adversaries of gaining intel.
1389 *
1390 * Enable sending of all alert messages
1391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001393
1394/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001395 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1396 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001397 * Enable support for the DTLS Connection ID (CID) extension,
Gilles Peskined3d02902020-03-04 21:35:27 +01001398 * which allows to identify DTLS connections across changes
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001399 * in the underlying transport. The CID functionality is described
1400 * in RFC 9146.
Gilles Peskined3d02902020-03-04 21:35:27 +01001401 *
1402 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001403 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1404 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1405 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001406 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001407 * The maximum lengths of outgoing and incoming CIDs can be configured
1408 * through the options
1409 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1410 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1411 *
1412 * Requires: MBEDTLS_SSL_PROTO_DTLS
1413 *
1414 * Uncomment to enable the Connection ID extension.
1415 */
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001416#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1417
1418
1419/**
1420 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT
1421 *
1422 * Defines whether RFC 9146 (default) or the legacy version
1423 * (version draft-ietf-tls-dtls-connection-id-05,
1424 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1425 * is used.
1426 *
1427 * Set the value to 0 for the standard version, and
1428 * 1 for the legacy draft version.
1429 *
Hannes Tschofenige2c46e02022-11-23 10:44:11 +01001430 * \deprecated Support for the legacy version of the DTLS
1431 * Connection ID feature is deprecated. Please
1432 * switch to the standardized version defined
1433 * in RFC 9146 enabled by utilizing
1434 * MBEDTLS_SSL_DTLS_CONNECTION_ID without use
1435 * of MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT.
1436 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02001437 * Requires: MBEDTLS_SSL_DTLS_CONNECTION_ID
1438 */
1439#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
Gilles Peskined3d02902020-03-04 21:35:27 +01001440
1441/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001442 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1443 *
1444 * Enable asynchronous external private key operations in SSL. This allows
1445 * you to configure an SSL connection to call an external cryptographic
1446 * module to perform private key operations instead of performing the
1447 * operation inside the library.
1448 *
Valerio Setti8841d6b2023-01-05 08:40:24 +01001449 * Requires: MBEDTLS_X509_CRT_PARSE_C
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001450 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001451//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001452
1453/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001454 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1455 *
1456 * Enable serialization of the TLS context structures, through use of the
1457 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1458 *
1459 * This pair of functions allows one side of a connection to serialize the
1460 * context associated with the connection, then free or re-use that context
1461 * while the serialized state is persisted elsewhere, and finally deserialize
1462 * that state to a live context for resuming read/write operations on the
1463 * connection. From a protocol perspective, the state of the connection is
1464 * unaffected, in particular this is entirely transparent to the peer.
1465 *
1466 * Note: this is distinct from TLS session resumption, which is part of the
1467 * protocol and fully visible by the peer. TLS session resumption enables
1468 * establishing new connections associated to a saved session with shorter,
1469 * lighter handshakes, while context serialization is a local optimization in
1470 * handling a single, potentially long-lived connection.
1471 *
1472 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1473 * saved after the handshake to allow for more efficient serialization, so if
1474 * you don't need this feature you'll save RAM by disabling it.
1475 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001476 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1477 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001478 * Comment to disable the context serialization APIs.
1479 */
1480#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1481
1482/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001484 *
1485 * Enable the debug messages in SSL module for all issues.
1486 * Debug messages have been disabled in some places to prevent timing
1487 * attacks due to (unbalanced) debugging function calls.
1488 *
1489 * If you need all error reporting you should enable this during debugging,
1490 * but remove this for production servers that should log as well.
1491 *
1492 * Uncomment this macro to report all debug messages on errors introducing
1493 * a timing side-channel.
1494 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001499 *
1500 * Enable support for Encrypt-then-MAC, RFC 7366.
1501 *
1502 * This allows peers that both support it to use a more robust protection for
1503 * ciphersuites using CBC, providing deep resistance against timing attacks
1504 * on the padding or underlying cipher.
1505 *
1506 * This only affects CBC ciphersuites, and is useless if none is defined.
1507 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001508 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001509 *
1510 * Comment this macro to disable support for Encrypt-then-MAC
1511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001513
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001515 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001516 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1517 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001518 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001519 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001520 * attacks, but it is recommended to always use it (even if you disable
1521 * renegotiation), since it actually fixes a more fundamental issue in the
1522 * original SSL/TLS design, and has implications beyond Triple Handshake.
1523 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001524 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001525 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001526 * Comment this macro to disable support for Extended Master Secret.
1527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001529
Paul Bakkerd66f0702013-01-31 16:57:45 +01001530/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001531 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1532 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001533 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001534 * giving access to the peer's certificate after completion of the handshake.
1535 *
1536 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1537 * recommended to disable this option for reduced RAM usage.
1538 *
1539 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1540 * defined, but always returns \c NULL.
1541 *
1542 * \note This option has no influence on the protection against the
1543 * triple handshake attack. Even if it is disabled, Mbed TLS will
1544 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001545 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001546 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001547 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001548 *
1549 * Comment this macro to disable storing the peer's certificate
1550 * after the handshake.
1551 */
1552#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1553
1554/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001556 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001557 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001558 *
1559 * The two main uses of renegotiation are (1) refresh keys on long-lived
1560 * connections and (2) client authentication after the initial handshake.
1561 * If you don't need renegotiation, it's probably better to disable it, since
1562 * it has been associated with security issues in the past and is easy to
1563 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001564 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001565 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001566 *
1567 * \note Even if this option is disabled, both client and server are aware
1568 * of the Renegotiation Indication Extension (RFC 5746) used to
1569 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1570 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1571 * configuration of this extension).
1572 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001573 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001575
1576/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001577 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001578 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001579 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001580 *
1581 * Comment this macro to disable support for the max_fragment_length extension
1582 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001583#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001584
1585/**
Jan Bruckner151f6422023-02-10 12:45:19 +01001586 * \def MBEDTLS_SSL_RECORD_SIZE_LIMIT
1587 *
Jan Brucknera0589e72023-03-15 11:04:45 +01001588 * Enable support for RFC 8449 record_size_limit extension in SSL (TLS 1.3 only).
Jan Bruckner151f6422023-02-10 12:45:19 +01001589 *
1590 * \warning This extension is currently in development and must NOT be used except
1591 * for testing purposes.
1592 *
1593 * Requires: MBEDTLS_SSL_PROTO_TLS1_3
1594 *
1595 * Uncomment this macro to enable support for the record_size_limit extension
1596 */
1597//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
1598
1599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001601 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001602 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001603 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001604 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001605 * (MBEDTLS_SHA256_C or MBEDTLS_SHA384_C or
1606 * SHA-256 or SHA-512 provided by a PSA driver)
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001607 * With MBEDTLS_USE_PSA_CRYPTO:
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001608 * PSA_WANT_ALG_SHA_256 or PSA_WANT_ALG_SHA_384
Andrzej Kureke02da812022-08-17 17:04:49 -04001609 *
Manuel Pégourié-Gonnarda22857b2023-03-23 13:20:44 +01001610 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, or if the hash(es) used
1611 * are only provided by PSA drivers, you must call psa_crypto_init() before
1612 * doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001613 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001614 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001615 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001617
1618/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001619 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001620 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001621 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001622 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001623 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1624 * pre-shared keys are not supported.
1625 * See docs/architecture/tls13-support.md for a description of the TLS
1626 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001627 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001628 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001629 * Requires: MBEDTLS_PSA_CRYPTO_C
Ronald Cron6f135e12021-12-08 16:57:54 +01001630 *
Gilles Peskine8c2830a2022-08-04 23:37:51 +02001631 * \note TLS 1.3 uses PSA crypto for cryptographic operations that are
1632 * directly performed by TLS 1.3 code. As a consequence, you must
1633 * call psa_crypto_init() before the first TLS 1.3 handshake.
1634 *
1635 * \note Cryptographic operations performed indirectly via another module
1636 * (X.509, PK) or by code shared with TLS 1.2 (record protection,
1637 * running handshake hash) only use PSA crypto if
1638 * #MBEDTLS_USE_PSA_CRYPTO is enabled.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001639 *
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001640 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001641 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001642//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001643
1644/**
Ronald Cronab65c522021-11-24 10:47:20 +01001645 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1646 *
1647 * Enable TLS 1.3 middlebox compatibility mode.
1648 *
1649 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1650 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1651 * expecting TLS 1.2 traffic.
1652 *
1653 * Turning on the compatibility mode comes at the cost of a few added bytes
1654 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1655 * that don't use it. Therefore, unless transmission bandwidth is critical and
1656 * you know that middlebox compatibility issues won't occur, it is therefore
1657 * recommended to set this option.
1658 *
1659 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001660 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1661 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001662 *
1663 */
1664//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1665
1666/**
Ronald Crond8d2ea52022-10-04 15:48:06 +02001667 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1668 *
1669 * Enable TLS 1.3 PSK key exchange mode.
1670 *
1671 * Comment to disable support for the PSK key exchange mode in TLS 1.3. If
1672 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1673 * effect on the build.
1674 *
1675 */
1676#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
1677
1678/**
1679 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1680 *
1681 * Enable TLS 1.3 ephemeral key exchange mode.
1682 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001683 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Manuel Pégourié-Gonnard4fa702a2023-03-29 12:15:24 +02001684 * MBEDTLS_X509_CRT_PARSE_C
1685 * and at least one of:
1686 * MBEDTLS_ECDSA_C or (MBEDTLS_USE_PSA_CRYPTO and PSA_WANT_ALG_ECDSA)
1687 * MBEDTLS_PKCS1_V21
Ronald Crond8d2ea52022-10-04 15:48:06 +02001688 *
1689 * Comment to disable support for the ephemeral key exchange mode in TLS 1.3.
1690 * If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1691 * effect on the build.
1692 *
1693 */
1694#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
1695
1696/**
1697 * \def MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1698 *
1699 * Enable TLS 1.3 PSK ephemeral key exchange mode.
1700 *
Przemek Stekielce05f542023-06-15 16:44:08 +02001701 * Requires: PSA_WANT_ALG_ECDH or PSA_WANT_ALG_FFDH
Ronald Crond8d2ea52022-10-04 15:48:06 +02001702 *
1703 * Comment to disable support for the PSK ephemeral key exchange mode in
1704 * TLS 1.3. If MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not
1705 * have any effect on the build.
1706 *
1707 */
1708#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1709
1710/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 * \def MBEDTLS_SSL_EARLY_DATA
1712 *
1713 * Enable support for RFC 8446 TLS 1.3 early data.
1714 *
1715 * Requires: MBEDTLS_SSL_SESSION_TICKETS and either
1716 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED or
1717 * MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
1718 *
1719 * Comment this to disable support for early data. If MBEDTLS_SSL_PROTO_TLS1_3
1720 * is not enabled, this option does not have any effect on the build.
1721 *
1722 * This feature is experimental, not completed and thus not ready for
1723 * production.
1724 *
1725 */
Ronald Cronc2e110f2022-11-22 09:01:46 +01001726//#define MBEDTLS_SSL_EARLY_DATA
Xiaokang Qian54413b12022-10-20 05:57:03 +00001727
1728/**
Jerry Yu16f68532022-11-05 10:50:06 +08001729 * \def MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1730 *
Jerry Yu12c46bd2022-12-06 11:02:51 +08001731 * The default maximum amount of 0-RTT data. See the documentation of
1732 * \c mbedtls_ssl_tls13_conf_max_early_data_size() for more information.
1733 *
1734 * It must be positive and smaller than UINT32_MAX.
1735 *
1736 * If MBEDTLS_SSL_EARLY_DATA is not defined, this default value does not
1737 * have any impact on the build.
Jerry Yu16f68532022-11-05 10:50:06 +08001738 *
1739 * This feature is experimental, not completed and thus not ready for
1740 * production.
1741 *
1742 */
1743#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
1744
1745/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001747 *
1748 * Enable support for DTLS (all available versions).
1749 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001750 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001751 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001752 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001753 *
1754 * Comment this macro to disable support for DTLS
1755 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001757
1758/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001759 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001760 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001761 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001762 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001763 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001764 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001765#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001766
1767/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001768 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001769 *
1770 * Enable support for the anti-replay mechanism in DTLS.
1771 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001772 * Requires: MBEDTLS_SSL_TLS_C
1773 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001774 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001775 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001776 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001777 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001778 * Comment this to disable anti-replay in DTLS.
1779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001780#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001781
1782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001784 *
1785 * Enable support for HelloVerifyRequest on DTLS servers.
1786 *
1787 * This feature is highly recommended to prevent DTLS servers being used as
1788 * amplifiers in DoS attacks against other hosts. It should always be enabled
1789 * unless you know for sure amplification cannot be a problem in the
1790 * environment in which your server operates.
1791 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001792 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001793 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001794 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001795 *
1796 * Comment this to disable support for HelloVerifyRequest.
1797 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001798#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001799
1800/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001801 * \def MBEDTLS_SSL_DTLS_SRTP
1802 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001803 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001804 * through the use_srtp extension.
1805 *
1806 * \note This feature provides the minimum functionality required
1807 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1808 * the associated SRTP packet protection key material.
1809 * In particular, the SRTP packet protection itself, as well as the
1810 * demultiplexing of RTP and DTLS packets at the datagram layer
1811 * (see Section 5 of RFC 5764), are not handled by this feature.
1812 * Instead, after successful completion of a handshake negotiating
1813 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001814 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001815 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1816 * (this is implemented in the SSL example programs).
1817 * The resulting key should then be passed to an SRTP stack.
1818 *
1819 * Setting this option enables the runtime API
1820 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1821 * through which the supported DTLS-SRTP protection
1822 * profiles can be configured. You must call this API at
1823 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001824 *
1825 * Requires: MBEDTLS_SSL_PROTO_DTLS
1826 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001827 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001828 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001829//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001830
1831/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001832 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1833 *
1834 * Enable server-side support for clients that reconnect from the same port.
1835 *
1836 * Some clients unexpectedly close the connection and try to reconnect using the
1837 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001838 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001839 * flag enables that support.
1840 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001841 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001842 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001843 * Comment this to disable support for clients reusing the source port.
1844 */
1845#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1846
1847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001849 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001850 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001851 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001852 * session store remains the responsibility of the application, though).
1853 * Server-side, you also need to provide callbacks for writing and parsing
1854 * tickets, including authenticated encryption and key management. Example
1855 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001856 *
1857 * Comment this macro to disable support for SSL session tickets
1858 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001860
1861/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001863 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001864 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001865 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001867 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001868 * Comment this macro to disable support for server name indication in SSL
1869 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001871
1872/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001873 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1874 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001875 * When this option is enabled, the SSL buffer will be resized automatically
1876 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001877 *
1878 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001879 */
1880//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1881
1882/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001883 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1884 *
1885 * Enable testing of the constant-flow nature of some sensitive functions with
1886 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001887 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001888 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001889 * This setting requires compiling with clang -fsanitize=memory. The test
1890 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001891 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001892 * \warning This macro is only used for extended testing; it is not considered
1893 * part of the library's API, so it may change or disappear at any time.
1894 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001895 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001896 */
1897//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1898
1899/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001900 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1901 *
1902 * Enable testing of the constant-flow nature of some sensitive functions with
1903 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001904 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001905 *
1906 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001907 * testing if the tests suites are run with valgrind's memcheck. This can be
1908 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1909 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001910 *
1911 * \warning This macro is only used for extended testing; it is not considered
1912 * part of the library's API, so it may change or disappear at any time.
1913 *
1914 * Uncomment to enable testing of the constant-flow nature of selected code.
1915 */
1916//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1917
1918/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001919 * \def MBEDTLS_TEST_HOOKS
1920 *
1921 * Enable features for invasive testing such as introspection functions and
1922 * hooks for fault injection. This enables additional unit tests.
1923 *
1924 * Merely enabling this feature should not change the behavior of the product.
1925 * It only adds new code, and new branching points where the default behavior
1926 * is the same as when this feature is disabled.
1927 * However, this feature increases the attack surface: there is an added
1928 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1929 * Therefore this feature must never be enabled in production.
1930 *
1931 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1932 * information.
1933 *
1934 * Uncomment to enable invasive tests.
1935 */
1936//#define MBEDTLS_TEST_HOOKS
1937
1938/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001939 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001940 *
1941 * Provide your own alternate threading implementation.
1942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001944 *
1945 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001946 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001948
1949/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001951 *
1952 * Enable the pthread wrapper layer for the threading layer.
1953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001955 *
1956 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001957 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001958//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001959
1960/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001961 * \def MBEDTLS_USE_PSA_CRYPTO
1962 *
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001963 * Make the X.509 and TLS libraries use PSA for cryptographic operations as
1964 * much as possible, and enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001965 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001966 * \note Development of this option is currently in progress, and parts of Mbed
1967 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001968 * will still continue to work as usual, so enabling this option should not
1969 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001970 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001971 * \warning If you enable this option, you need to call `psa_crypto_init()`
valeriocf35d772023-04-20 10:37:53 +02001972 * before calling any function from the SSL/TLS, X.509 or PK modules, except
1973 * for the various mbedtls_xxx_init() functions which can be called at any time.
Hanno Becker51560b62018-11-19 09:46:26 +00001974 *
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001975 * \note An important and desirable effect of this option is that it allows
1976 * PK, X.509 and TLS to take advantage of PSA drivers. For example, enabling
1977 * this option is what allows use of drivers for ECDSA, ECDH and EC J-PAKE in
Manuel Pégourié-Gonnard9463e782023-03-30 09:37:39 +02001978 * those modules. However, note that even with this option disabled, some code
Manuel Pégourié-Gonnard93b21e72023-03-29 10:30:26 +02001979 * in PK, X.509, TLS or the crypto library might still use PSA drivers, if it
1980 * can determine it's safe to do so; currently that's the case for hashes.
Manuel Pégourié-Gonnard2ca08c82023-03-24 09:21:46 +01001981 *
1982 * \note See docs/use-psa-crypto.md for a complete description this option.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001983 *
1984 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001985 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001986 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 */
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001988//#define MBEDTLS_USE_PSA_CRYPTO
1989
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001991 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1992 *
John Durkop185764f2020-10-12 21:32:12 -07001993 * This setting allows support for cryptographic mechanisms through the PSA
1994 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001995 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001996 * When this option is disabled, the PSA API exposes the cryptographic
1997 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1998 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001999 *
2000 * When this option is enabled, the PSA API exposes the cryptographic
2001 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
2002 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
2003 * automatically enabled if required (i.e. if no PSA driver provides the
2004 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
2005 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002006 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01002007 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02002008 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01002009 *
John Durkop185764f2020-10-12 21:32:12 -07002010 * This feature is still experimental and is not ready for production since
2011 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07002012 */
2013//#define MBEDTLS_PSA_CRYPTO_CONFIG
2014
2015/**
Paul Bakker1f2bc622013-08-15 13:45:55 +02002016 * \def MBEDTLS_VERSION_FEATURES
2017 *
2018 * Allow run-time checking of compile-time enabled features. Thus allowing users
2019 * to check at run-time if the library is for instance compiled with threading
Paul Bakker5c721f92011-07-27 16:51:09 +00002020 * support via mbedtls_version_check_feature().
2021 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002022 * Requires: MBEDTLS_VERSION_C
Paul Bakker5c721f92011-07-27 16:51:09 +00002023 *
2024 * Comment this to disable run-time checking and save ROM space
2025 */
2026#define MBEDTLS_VERSION_FEATURES
2027
2028/**
Hanno Becker288dedc2019-03-27 11:00:53 +00002029 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2030 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002031 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00002032 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
2033 * the set of trusted certificates through a callback instead of a linked
2034 * list.
2035 *
2036 * This is useful for example in environments where a large number of trusted
2037 * certificates is present and storing them in a linked list isn't efficient
2038 * enough, or when the set of trusted certificates changes frequently.
2039 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03002040 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00002041 * `mbedtls_ssl_conf_ca_cb()` for more information.
2042 *
Valerio Setti8e45cdd2023-01-05 09:32:29 +01002043 * Requires: MBEDTLS_X509_CRT_PARSE_C
2044 *
Hanno Becker288dedc2019-03-27 11:00:53 +00002045 * Uncomment to enable trusted certificate callbacks.
2046 */
2047//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
2048
2049/**
Hanno Becker612a2f12020-10-09 09:19:39 +01002050 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002051 *
Chris Jones2c745862020-12-16 11:41:06 +00002052 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06002053 *
Chris Jones2c745862020-12-16 11:41:06 +00002054 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06002055 * and other functions/constants only used by these functions, thus reducing
2056 * the code footprint by several KB.
2057 */
Chris Jones2c745862020-12-16 11:41:06 +00002058//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06002059
2060/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02002062 *
2063 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
2064 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
2065 *
2066 * Comment this macro to disallow using RSASSA-PSS in certificates.
2067 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01002069/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00002070
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002071/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002072 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00002073 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002074 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00002075 * \{
2076 */
Paul Bakker5121ce52009-01-03 21:22:43 +00002077
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002078/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002080 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002081 * Enable AES-NI support on x86-64 or x86-32.
2082 *
2083 * \note AESNI is only supported with certain compilers and target options:
2084 * - Visual Studio 2013: supported.
2085 * - GCC, x86-64, target not explicitly supporting AESNI:
2086 * requires MBEDTLS_HAVE_ASM.
2087 * - GCC, x86-32, target not explicitly supporting AESNI:
2088 * not supported.
2089 * - GCC, x86-64 or x86-32, target supporting AESNI: supported.
2090 * For this assembly-less implementation, you must currently compile
2091 * `library/aesni.c` and `library/aes.c` with machine options to enable
2092 * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or
2093 * `clang -maes -mpclmul`.
2094 * - Non-x86 targets: this option is silently ignored.
2095 * - Other compilers: this option is silently ignored.
2096 *
2097 * \note
2098 * Above, "GCC" includes compatible compilers such as Clang.
2099 * The limitations on target support are likely to be relaxed in the future.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002100 *
2101 * Module: library/aesni.c
2102 * Caller: library/aes.c
2103 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002104 * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002105 *
Gilles Peskine0bfccfa2023-03-16 17:49:44 +01002106 * This modules adds support for the AES-NI instructions on x86.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002107 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002109
2110/**
Jerry Yu2fddfd72023-01-10 16:32:03 +08002111 * \def MBEDTLS_AESCE_C
2112 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002113 * Enable AES cryptographic extension support on 64-bit Arm.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002114 *
2115 * Module: library/aesce.c
2116 * Caller: library/aes.c
2117 *
Jerry Yuf015a932023-04-25 10:38:03 +08002118 * Requires: MBEDTLS_AES_C
Jerry Yu2fddfd72023-01-10 16:32:03 +08002119 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002120 * \warning Runtime detection only works on Linux. For non-Linux operating
2121 * system, Armv8-A Cryptographic Extensions must be supported by
2122 * the CPU when this option is enabled.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002123 *
Jerry Yua1a039d2023-04-26 10:21:42 +08002124 * \note Minimum compiler versions for this feature are Clang 4.0,
Jerry Yu8bfa24b2023-05-05 14:35:00 +08002125 * armclang 6.6, GCC 6.0 or MSVC 2019 version 16.11.2.
2126 *
2127 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
2128 * armclang <= 6.9
Jerry Yu2fddfd72023-01-10 16:32:03 +08002129 *
Dave Rodgmanf918d422023-03-17 17:52:23 +00002130 * This module adds support for the AES Armv8-A Cryptographic Extensions on Aarch64 systems.
Jerry Yu2fddfd72023-01-10 16:32:03 +08002131 */
2132#define MBEDTLS_AESCE_C
2133
2134/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002135 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002136 *
2137 * Enable the AES block cipher.
2138 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002139 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002140 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002141 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00002142 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002143 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002144 * This module enables the following ciphersuites (if other requisites are
2145 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
2147 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
2148 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
2149 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
2150 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
2151 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
2152 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
2153 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
2154 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
2155 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
2156 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
2157 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
2158 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
2159 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
2160 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
2161 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
2162 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
2163 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
2164 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
2165 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
2166 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
2167 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
2168 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
2169 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
2170 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
2171 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
2172 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
2173 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
2174 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
2175 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
2176 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
2177 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
2178 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
2179 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
2180 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
2181 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
2182 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
2183 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
2184 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
2185 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
2186 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
2187 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
2188 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
2189 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
2190 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
2191 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
2192 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
2193 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
2194 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
2195 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
2196 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
2197 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
2198 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
2199 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
2200 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2201 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2202 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2203 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002204 *
Paul Bakkercff68422013-09-15 20:43:33 +02002205 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002206 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002207#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002208
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002209/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002210 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002211 *
2212 * Enable the generic ASN1 parser.
2213 *
2214 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002215 * Caller: library/x509.c
2216 * library/dhm.c
2217 * library/pkcs12.c
2218 * library/pkcs5.c
2219 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002222
2223/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002225 *
2226 * Enable the generic ASN1 writer.
2227 *
2228 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002229 * Caller: library/ecdsa.c
2230 * library/pkwrite.c
2231 * library/x509_create.c
2232 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002233 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002236
2237/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002238 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002239 *
2240 * Enable the Base64 module.
2241 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002242 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002243 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002244 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002245 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002248
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002249/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002251 *
Paul Bakker9a736322012-11-14 12:39:52 +00002252 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002253 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002254 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002255 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002256 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002257 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002259 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002260 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002262 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002264 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002265 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271 *
2272 * Enable the Camellia block cipher.
2273 *
Paul Bakker38119b12009-01-10 23:31:23 +00002274 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002275 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002276 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002277 * This module enables the following ciphersuites (if other requisites are
2278 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2280 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2281 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2282 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2283 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2284 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2285 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2286 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2287 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2288 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2289 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2290 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2291 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2292 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2293 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2294 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2295 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2296 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2297 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2298 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2299 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2300 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2301 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2302 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2303 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2304 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2305 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2306 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2307 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2308 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2309 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2310 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2311 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2312 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2313 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2314 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2315 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2316 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2317 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2318 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2319 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2320 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002322#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002323
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002324/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002325 * \def MBEDTLS_ARIA_C
2326 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002327 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002328 *
2329 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002330 * Caller: library/cipher.c
2331 *
2332 * This module enables the following ciphersuites (if other requisites are
2333 * enabled as well):
2334 *
2335 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2336 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2337 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2338 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2339 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2340 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2341 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2342 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2343 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2344 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2345 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2346 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2347 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2348 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2349 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2350 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2351 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2352 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2353 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2354 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2355 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2356 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2357 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2358 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2359 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2360 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2361 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2362 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2363 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2364 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2365 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2366 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2367 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2368 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2369 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2370 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2371 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2372 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002373 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002374#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002375
2376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002378 *
2379 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2380 *
2381 * Module: library/ccm.c
2382 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002383 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2384 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002385 *
2386 * This module enables the AES-CCM ciphersuites, if other requisites are
2387 * enabled as well.
2388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002390
2391/**
Daniel King34b822c2016-05-15 17:28:08 -03002392 * \def MBEDTLS_CHACHA20_C
2393 *
2394 * Enable the ChaCha20 stream cipher.
2395 *
2396 * Module: library/chacha20.c
2397 */
2398#define MBEDTLS_CHACHA20_C
2399
2400/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002401 * \def MBEDTLS_CHACHAPOLY_C
2402 *
2403 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2404 *
2405 * Module: library/chachapoly.c
2406 *
2407 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2408 */
2409#define MBEDTLS_CHACHAPOLY_C
2410
2411/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002413 *
2414 * Enable the generic cipher layer.
2415 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002416 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002417 * Caller: library/ccm.c
2418 * library/cmac.c
2419 * library/gcm.c
2420 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002421 * library/pkcs12.c
2422 * library/pkcs5.c
2423 * library/psa_crypto_aead.c
2424 * library/psa_crypto_mac.c
2425 * library/ssl_ciphersuites.c
2426 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002427 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002428 *
2429 * Uncomment to enable generic cipher wrappers.
2430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002432
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002433/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002434 * \def MBEDTLS_CMAC_C
2435 *
Simon Butcher327398a2016-10-05 14:09:11 +01002436 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2437 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002438 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002439 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2440 * implementation of the CMAC algorithm is provided by an alternate
2441 * implementation, that alternate implementation may opt to not support
2442 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2443 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002444 * Module: library/cmac.c
2445 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002446 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002447 *
2448 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002449#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002450
2451/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002453 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002454 * Enable the CTR_DRBG AES-based random generator.
2455 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002456 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002457 *
Yanray Wang55ef22c2023-06-15 09:57:06 +08002458 * \note AES-128 will be used if \c MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH is set.
2459 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002460 * \note To achieve a 256-bit security strength with CTR_DRBG,
2461 * you must use AES-256 *and* use sufficient entropy.
2462 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002463 *
2464 * Module: library/ctr_drbg.c
2465 * Caller:
2466 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002468 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002469 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002472
2473/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002474 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002475 *
2476 * Enable the debug functions.
2477 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002478 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002479 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002480 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002481 * library/ssl_tls12_*.c
2482 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002483 *
2484 * This module provides debugging functions.
2485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002487
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002488/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002490 *
2491 * Enable the DES block cipher.
2492 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002493 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002494 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002495 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002496 *
Paul Bakkercff68422013-09-15 20:43:33 +02002497 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002498 *
Dave Rodgmanc04515b2023-02-02 10:47:58 +00002499 * \warning DES/3DES are considered weak ciphers and their use constitutes a
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002500 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002501 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002502#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002503
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002504/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002505 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002506 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002507 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002508 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002509 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002510 * Caller: library/ssl_tls.c
2511 * library/ssl*_client.c
2512 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002514 * This module is used by the following key exchanges:
2515 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002516 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002517 * \warning Using DHE constitutes a security risk as it
2518 * is not possible to validate custom DH parameters.
2519 * If possible, it is recommended users should consider
2520 * preferring other methods of key exchange.
2521 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002522 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002523 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002524#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002525
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002526/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002528 *
2529 * Enable the elliptic curve Diffie-Hellman library.
2530 *
2531 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002532 * Caller: library/psa_crypto.c
2533 * library/ssl_tls.c
2534 * library/ssl*_client.c
2535 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002536 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002537 * This module is used by the following key exchanges:
2538 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002539 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002543
2544/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002546 *
2547 * Enable the elliptic curve DSA library.
2548 *
2549 * Module: library/ecdsa.c
2550 * Caller:
2551 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002552 * This module is used by the following key exchanges:
2553 * ECDHE-ECDSA
2554 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002555 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2556 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2557 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002558 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002559#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002560
2561/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002562 * \def MBEDTLS_ECJPAKE_C
2563 *
2564 * Enable the elliptic curve J-PAKE library.
2565 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002566 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2567 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002568 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002569 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002570 * Module: library/ecjpake.c
2571 * Caller:
2572 *
2573 * This module is used by the following key exchanges:
2574 * ECJPAKE
2575 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002576 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002577 *
Manuel Pégourié-Gonnard41bc8b62023-03-14 23:59:24 +01002578 * \warning If using a hash that is only provided by PSA drivers, you must
2579 * call psa_crypto_init() before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002580 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002581#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002582
2583/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002584 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002585 *
2586 * Enable the elliptic curve over GF(p) library.
2587 *
2588 * Module: library/ecp.c
2589 * Caller: library/ecdh.c
2590 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002591 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002592 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002593 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002594 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002596
2597/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002599 *
2600 * Enable the platform-specific entropy code.
2601 *
2602 * Module: library/entropy.c
2603 * Caller:
2604 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002606 *
2607 * This module provides a generic entropy pool
2608 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002609#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002610
2611/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002613 *
2614 * Enable error code to error string conversion.
2615 *
2616 * Module: library/error.c
2617 * Caller:
2618 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002619 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002622
2623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002625 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002626 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002627 *
2628 * Module: library/gcm.c
2629 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002630 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2631 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002632 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002633 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2634 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002636#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002637
2638/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002639 * \def MBEDTLS_HKDF_C
2640 *
2641 * Enable the HKDF algorithm (RFC 5869).
2642 *
2643 * Module: library/hkdf.c
2644 * Caller:
2645 *
2646 * Requires: MBEDTLS_MD_C
2647 *
2648 * This module adds support for the Hashed Message Authentication Code
2649 * (HMAC)-based key derivation function (HKDF).
2650 */
2651#define MBEDTLS_HKDF_C
2652
2653/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002655 *
2656 * Enable the HMAC_DRBG random generator.
2657 *
2658 * Module: library/hmac_drbg.c
2659 * Caller:
2660 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002661 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002662 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002663 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002666
2667/**
Raef Coles8ff6df52021-07-21 12:42:15 +01002668 * \def MBEDTLS_LMS_C
2669 *
2670 * Enable the LMS stateful-hash asymmetric signature algorithm.
2671 *
2672 * Module: library/lms.c
2673 * Caller:
2674 *
Raef Colesab4f8742022-09-01 12:24:31 +01002675 * Requires: MBEDTLS_PSA_CRYPTO_C
Raef Coles8ff6df52021-07-21 12:42:15 +01002676 *
Raef Colesab4f8742022-09-01 12:24:31 +01002677 * Uncomment to enable the LMS verification algorithm and public key operations.
Raef Coles8ff6df52021-07-21 12:42:15 +01002678 */
2679#define MBEDTLS_LMS_C
2680
2681/**
Raef Colesab4f8742022-09-01 12:24:31 +01002682 * \def MBEDTLS_LMS_PRIVATE
2683 *
2684 * Enable LMS private-key operations and signing code. Functions enabled by this
2685 * option are experimental, and should not be used in production.
2686 *
2687 * Requires: MBEDTLS_LMS_C
2688 *
2689 * Uncomment to enable the LMS signature algorithm and private key operations.
2690 */
Raef Coles5127e852022-10-07 10:35:56 +01002691//#define MBEDTLS_LMS_PRIVATE
Raef Colesab4f8742022-09-01 12:24:31 +01002692
2693/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002694 * \def MBEDTLS_NIST_KW_C
2695 *
2696 * Enable the Key Wrapping mode for 128-bit block ciphers,
2697 * as defined in NIST SP 800-38F. Only KW and KWP modes
2698 * are supported. At the moment, only AES is approved by NIST.
2699 *
2700 * Module: library/nist_kw.c
2701 *
2702 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2703 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002704#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002705
2706/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002707 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002708 *
Manuel Pégourié-Gonnardb9b630d2023-02-16 19:07:31 +01002709 * Enable the generic layer for message digest (hashing) and HMAC.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002710 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002711 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2712 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002713 * MBEDTLS_SHA512_C, or MBEDTLS_PSA_CRYPTO_C with at least
Manuel Pégourié-Gonnard534d64d2023-03-14 17:43:06 +01002714 * one hash.
Simon Butcher2cb47392016-11-04 12:23:11 +00002715 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002716 * Caller: library/constant_time.c
2717 * library/ecdsa.c
2718 * library/ecjpake.c
2719 * library/hkdf.c
2720 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002721 * library/pk.c
2722 * library/pkcs5.c
2723 * library/pkcs12.c
2724 * library/psa_crypto_ecp.c
2725 * library/psa_crypto_rsa.c
2726 * library/rsa.c
2727 * library/ssl_cookie.c
2728 * library/ssl_msg.c
2729 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002730 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002731 * library/x509_crt.c
2732 * library/x509write_crt.c
2733 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002734 *
2735 * Uncomment to enable generic message digest wrappers.
2736 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002738
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002739/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002741 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002742 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002743 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002744 * Module: library/md5.c
2745 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002746 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002747 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002748 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002749 * This module is required for TLS 1.2 depending on the handshake parameters.
2750 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2751 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002752 *
2753 * \warning MD5 is considered a weak message digest and its use constitutes a
2754 * security risk. If possible, we recommend avoiding dependencies on
2755 * it, and considering stronger message digests instead.
2756 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002758#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002759
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002760/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002762 *
2763 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002764 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002765 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002766 *
2767 * Module: library/memory_buffer_alloc.c
2768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002769 * Requires: MBEDTLS_PLATFORM_C
2770 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002771 *
2772 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002775
2776/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002778 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002779 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2780 *
Simon Butcherd567a232016-03-09 20:19:21 +00002781 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2782 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002783 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002784 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002785 * \note See also our Knowledge Base article about porting to a new
2786 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01002787 * 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 +00002788 *
Andres AG788aa4a2016-09-14 14:32:09 +01002789 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002790 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002791 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002794
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002795/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002797 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002798 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002799 *
2800 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002801 * Caller: library/asn1write.c
2802 * library/pkcs5.c
2803 * library/pkparse.c
2804 * library/pkwrite.c
2805 * library/rsa.c
2806 * library/x509.c
2807 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002808 * library/x509_crl.c
2809 * library/x509_crt.c
2810 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002811 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002812 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002813 *
2814 * This modules translates between OIDs and internal values.
2815 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002817
2818/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002819 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002820 *
2821 * Enable VIA Padlock support on x86.
2822 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002823 * Module: library/padlock.c
2824 * Caller: library/aes.c
2825 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002827 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002828 * This modules adds support for the VIA PadLock on x86.
2829 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002830#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002831
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002832/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002834 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002835 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002836 *
2837 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002838 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002839 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002840 * library/x509_crl.c
2841 * library/x509_crt.c
2842 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002844 * Requires: MBEDTLS_BASE64_C
Manuel Pégourié-Gonnard1c2008f2023-03-16 10:20:29 +01002845 * optionally MBEDTLS_MD5_C, or PSA Crypto with MD5 (see below)
2846 *
2847 * \warning When parsing password-protected files, if MD5 is provided only by
2848 * a PSA driver, you must call psa_crypto_init() before the first file.
Paul Bakker5690efc2011-05-26 13:16:06 +00002849 *
Paul Bakkercff68422013-09-15 20:43:33 +02002850 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002853
2854/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002855 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002856 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002857 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002858 *
2859 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002860 * Caller: library/pkwrite.c
2861 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002862 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002863 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002864 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002865 *
2866 * This modules adds support for encoding / writing PEM files.
2867 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002868#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002869
2870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002872 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002873 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002874 *
2875 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002876 * Caller: library/psa_crypto_rsa.c
2877 * library/ssl_tls.c
2878 * library/ssl*_client.c
2879 * library/ssl*_server.c
2880 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002881 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002882 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002883 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002884 * Uncomment to enable generic public key wrappers.
2885 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002886#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002887
2888/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002890 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002891 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002892 *
2893 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002894 * Caller: library/x509_crt.c
2895 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002896 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002897 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002898 *
2899 * Uncomment to enable generic public key parse functions.
2900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002902
2903/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002905 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002906 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002907 *
2908 * Module: library/pkwrite.c
2909 * Caller: library/x509write.c
2910 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002911 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002912 *
2913 * Uncomment to enable generic public key write functions.
2914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002916
2917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002919 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002920 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002921 *
2922 * Module: library/pkcs5.c
2923 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002924 * Requires: MBEDTLS_CIPHER_C
Manuel Pégourié-Gonnard161dca62023-03-21 16:22:59 +01002925 * Auto-enables: MBEDTLS_MD_C
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002926 *
Manuel Pégourié-Gonnard49e67f82023-03-16 11:39:20 +01002927 * \warning If using a hash that is only provided by PSA drivers, you must
2928 * call psa_crypto_init() before doing any PKCS5 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002929 *
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002930 * This module adds support for the PKCS#5 functions.
2931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002933
2934/**
Nayna Jainc9deb182020-11-16 19:03:12 +00002935 * \def MBEDTLS_PKCS7_C
2936 *
Dave Rodgman3fe2abf2023-03-10 17:05:54 +00002937 * Enable PKCS #7 core for using PKCS #7-formatted signatures.
Nayna Jainc9deb182020-11-16 19:03:12 +00002938 * RFC Link - https://tools.ietf.org/html/rfc2315
2939 *
2940 * Module: library/pkcs7.c
2941 *
2942 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Nick Child89e82e12022-11-09 10:36:10 -06002943 * MBEDTLS_X509_CRT_PARSE_C MBEDTLS_X509_CRL_PARSE_C,
2944 * MBEDTLS_BIGNUM_C, MBEDTLS_MD_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002945 *
Dave Rodgmanefbc5f72023-03-13 12:15:49 +00002946 * This module is required for the PKCS #7 parsing modules.
Nayna Jainc9deb182020-11-16 19:03:12 +00002947 */
Dave Rodgman7c33b0c2023-03-10 15:07:15 +00002948#define MBEDTLS_PKCS7_C
Nayna Jainc9deb182020-11-16 19:03:12 +00002949
2950/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002952 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002953 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002954 * Adds algorithms for parsing PKCS#8 encrypted private keys
2955 *
2956 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002957 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002958 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002959 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2960 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2961 *
Manuel Pégourié-Gonnardbe97afe2023-03-16 10:00:54 +01002962 * \warning If using a hash that is only provided by PSA drivers, you must
2963 * call psa_crypto_init() before doing any PKCS12 operations.
Manuel Pégourié-Gonnard18a38562022-11-22 11:49:55 +01002964 *
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002965 * This module enables PKCS#12 functions.
2966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002968
2969/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002970 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002971 *
2972 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002973 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002974 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2976 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002977 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002978 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002979 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002980 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002981 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002982 * Module: library/platform.c
2983 * Caller: Most other .c files
2984 *
2985 * This module enables abstraction of common (libc) functions.
2986 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002987#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002988
2989/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002990 * \def MBEDTLS_POLY1305_C
2991 *
2992 * Enable the Poly1305 MAC algorithm.
2993 *
2994 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002995 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002996 */
2997#define MBEDTLS_POLY1305_C
2998
2999/**
Jaeden Amero484ee332018-10-25 17:38:05 +01003000 * \def MBEDTLS_PSA_CRYPTO_C
3001 *
3002 * Enable the Platform Security Architecture cryptography API.
3003 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01003004 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01003005 *
Przemek Stekielea805b42022-05-02 10:30:03 +02003006 * Requires: MBEDTLS_CIPHER_C,
3007 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01003008 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01003009 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01003010 *
3011 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01003012#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01003013
3014/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02003015 * \def MBEDTLS_PSA_CRYPTO_SE_C
3016 *
Gilles Peskine98473c42022-06-20 18:46:22 +02003017 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02003018 * cryptography API.
3019 *
Ronald Crone6e6b752023-01-16 16:56:51 +01003020 * \deprecated This feature is deprecated. Please switch to the PSA driver
3021 * interface.
Gilles Peskined0e66b02019-07-24 13:52:51 +02003022 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02003023 * Module: library/psa_crypto_se.c
3024 *
3025 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
3026 *
3027 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02003028//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02003029
3030/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05003031 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
3032 *
3033 * Enable the Platform Security Architecture persistent key storage.
3034 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01003035 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003036 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003037 * Requires: MBEDTLS_PSA_CRYPTO_C,
3038 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
3039 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05003040 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01003041#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003042
3043/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003044 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003045 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003046 * Enable the emulation of the Platform Security Architecture
3047 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05003048 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01003049 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05003050 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00003051 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05003052 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01003053#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05003054
3055/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003057 *
3058 * Enable the RIPEMD-160 hash algorithm.
3059 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003060 * Module: library/ripemd160.c
3061 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003062 *
3063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003064#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01003065
3066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003067 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003068 *
3069 * Enable the RSA public-key cryptosystem.
3070 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003071 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00003072 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003073 * Caller: library/pk.c
3074 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003075 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003076 * library/ssl*_client.c
3077 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003078 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02003079 * This module is used by the following key exchanges:
3080 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00003081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003083 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003085
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003086/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003087 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003088 *
3089 * Enable the SHA1 cryptographic hash algorithm.
3090 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003091 * Module: library/sha1.c
3092 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003093 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003094 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003095 * This module is required for TLS 1.2 depending on the handshake parameters,
3096 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01003097 *
3098 * \warning SHA-1 is considered a weak message digest and its use constitutes
3099 * a security risk. If possible, we recommend avoiding dependencies
3100 * on it, and considering stronger message digests instead.
3101 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003102 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003104
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003105/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003106 * \def MBEDTLS_SHA224_C
3107 *
3108 * Enable the SHA-224 cryptographic hash algorithm.
3109 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003110 * Module: library/sha256.c
3111 * Caller: library/md.c
3112 * library/ssl_cookie.c
3113 *
3114 * This module adds support for SHA-224.
3115 */
3116#define MBEDTLS_SHA224_C
3117
3118/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003120 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003121 * Enable the SHA-256 cryptographic hash algorithm.
3122 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003123 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003124 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003125 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003126 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003127 * library/ssl*_client.c
3128 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003129 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003130 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01003131 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00003132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003133#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003134
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003135/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003136 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3137 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003138 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3139 * with the ARMv8 cryptographic extensions if they are available at runtime.
3140 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003141 *
3142 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
3143 * for a non-Aarch64 build it will be silently ignored.
3144 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003145 * \note Minimum compiler versions for this feature are Clang 4.0,
3146 * armclang 6.6 or GCC 6.0.
3147 *
3148 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3149 * armclang <= 6.9
3150 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003151 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3152 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
3153 *
3154 * Requires: MBEDTLS_SHA256_C.
3155 *
3156 * Module: library/sha256.c
3157 *
3158 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
3159 * and use them if available.
3160 */
3161//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3162
3163/**
3164 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3165 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003166 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
3167 * with the ARMv8 cryptographic extensions, which must be available at runtime
3168 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003169 *
3170 * \note This allows builds with a smaller code size than with
3171 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
3172 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003173 * \note Minimum compiler versions for this feature are Clang 4.0,
3174 * armclang 6.6 or GCC 6.0.
3175 *
3176 * \note \c CFLAGS must be set to a minimum of \c -march=armv8-a+crypto for
3177 * armclang <= 6.9
3178 *
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00003179 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
3180 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
3181 *
3182 * Requires: MBEDTLS_SHA256_C.
3183 *
3184 * Module: library/sha256.c
3185 *
3186 * Uncomment to have the library use the A64 SHA-256 crypto extensions
3187 * unconditionally.
3188 */
3189//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
3190
3191/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003192 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003193 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003194 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003195 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003196 * Module: library/sha512.c
3197 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003198 * library/psa_crypto_hash.c
3199 * library/ssl_tls.c
3200 * library/ssl*_client.c
3201 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003202 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003203 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003204 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003205#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02003206
3207/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003209 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003210 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003211 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003212 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02003213 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003214 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02003215 * library/ssl_tls.c
3216 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003217 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02003218 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00003219 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003220#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003221
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003222/**
Pol Henarejos0cd1f1c2022-05-09 01:04:15 +02003223 * \def MBEDTLS_SHA3_C
3224 *
3225 * Enable the SHA3 cryptographic hash algorithm.
3226 *
3227 * Module: library/sha3.c
3228 *
3229 * This module adds support for SHA3.
3230 */
3231#define MBEDTLS_SHA3_C
3232
3233/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003234 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3235 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003236 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3237 * with the ARMv8 cryptographic extensions if they are available at runtime.
3238 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003239 *
3240 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
3241 * for a non-Aarch64 build it will be silently ignored.
3242 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003243 * \note Minimum compiler versions for this feature are Clang 7.0,
3244 * armclang 6.9 or GCC 8.0.
3245 *
3246 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3247 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003248 *
3249 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
3250 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
3251 *
3252 * Requires: MBEDTLS_SHA512_C.
3253 *
3254 * Module: library/sha512.c
3255 *
3256 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
3257 * and use them if available.
3258 */
3259//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3260
3261/**
3262 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3263 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003264 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3265 * with the ARMv8 cryptographic extensions, which must be available at runtime
3266 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003267 *
3268 * \note This allows builds with a smaller code size than with
3269 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3270 *
Jerry Yu8bfa24b2023-05-05 14:35:00 +08003271 * \note Minimum compiler versions for this feature are Clang 7.0,
3272 * armclang 6.9 or GCC 8.0.
3273 *
3274 * \note \c CFLAGS must be set to a minimum of \c -march=armv8.2-a+sha3 for
3275 * armclang 6.9
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003276 *
3277 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3278 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3279 *
3280 * Requires: MBEDTLS_SHA512_C.
3281 *
3282 * Module: library/sha512.c
3283 *
3284 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3285 * unconditionally.
3286 */
3287//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3288
3289/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003290 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003291 *
3292 * Enable simple SSL cache implementation.
3293 *
3294 * Module: library/ssl_cache.c
3295 * Caller:
3296 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003297 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003300
3301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003303 *
3304 * Enable basic implementation of DTLS cookies for hello verification.
3305 *
3306 * Module: library/ssl_cookie.c
3307 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003309#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003310
3311/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003312 * \def MBEDTLS_SSL_TICKET_C
3313 *
3314 * Enable an implementation of TLS server-side callbacks for session tickets.
3315 *
3316 * Module: library/ssl_ticket.c
3317 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003318 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003319 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3320 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003321 */
3322#define MBEDTLS_SSL_TICKET_C
3323
3324/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003326 *
3327 * Enable the SSL/TLS client code.
3328 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003329 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003330 * Caller:
3331 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003333 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003334 * This module is required for SSL/TLS client support.
3335 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003337
Paul Bakker9a736322012-11-14 12:39:52 +00003338/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003339 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003340 *
3341 * Enable the SSL/TLS server code.
3342 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003343 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003344 * Caller:
3345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003346 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003347 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003348 * This module is required for SSL/TLS server support.
3349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003350#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003351
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003352/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003354 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003355 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003356 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003357 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003358 * Caller: library/ssl*_client.c
3359 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003360 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3362 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003363 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 * This module is required for SSL/TLS.
3365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003366#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003367
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003368/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003369 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003370 *
3371 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003372 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003373 * contexts are not shared between threads. If you do intend to use contexts
3374 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003375 * conditions. See also our Knowledge Base article about threading:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003376 * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003377 *
3378 * Module: library/threading.c
3379 *
3380 * This allows different threading implementations (self-implemented or
3381 * provided).
3382 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003383 * You will have to enable either MBEDTLS_THREADING_ALT or
3384 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003385 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003386 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003389
3390/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003391 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003392 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003393 * Enable the semi-portable timing interface.
3394 *
Simon Butcherd567a232016-03-09 20:19:21 +00003395 * \note The provided implementation only works on POSIX/Unix (including Linux,
3396 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003397 * module and provide your own implementations of the callbacks needed by
3398 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3399 * your own implementation of the whole module by setting
3400 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003401 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003402 * \note The timing module will include time.h on suitable platforms
3403 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3404 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3405 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003406 * \note See also our Knowledge Base article about porting to a new
3407 * environment:
Dave Rodgmanb3196842022-10-12 16:47:08 +01003408 * 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 +00003409 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003410 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003411 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003413
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003414/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003416 *
3417 * Enable run-time version information.
3418 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003419 * Module: library/version.c
3420 *
3421 * This module provides run-time version information.
3422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003424
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003426 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003427 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003428 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003429 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003430 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003431 * Caller: library/x509_crl.c
3432 * library/x509_crt.c
3433 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003434 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003435 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003436 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3437 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003438 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3439 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003440 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003441 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003444
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003446 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003447 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003448 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003449 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003450 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003451 * Caller: library/ssl_tls.c
3452 * library/ssl*_client.c
3453 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003456 *
3457 * This module is required for X.509 certificate parsing.
3458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003459#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003460
3461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003463 *
3464 * Enable X.509 CRL parsing.
3465 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003466 * Module: library/x509_crl.c
3467 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003468 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003470 *
3471 * This module is required for X.509 CRL parsing.
3472 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003474
3475/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003477 *
3478 * Enable X.509 Certificate Signing Request (CSR) parsing.
3479 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003480 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003481 * Caller: library/x509_crt_write.c
3482 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003484 *
3485 * This module is used for reading X.509 certificate request.
3486 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003487#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003488
3489/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003491 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003492 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003493 *
3494 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003495 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003496 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003497 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3498 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003499 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3500 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003501 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003502 * This module is the basis for creating X.509 certificates and CSRs.
3503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003505
3506/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003508 *
3509 * Enable creating X.509 certificates.
3510 *
3511 * Module: library/x509_crt_write.c
3512 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003514 *
3515 * This module is required for X.509 certificate creation.
3516 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003518
3519/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003520 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003521 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003522 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003523 *
3524 * Module: library/x509_csr_write.c
3525 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003527 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003528 * This module is required for X.509 certificate request writing.
3529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003530#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003531
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003532/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003533
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003534/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003535 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003536 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003537 * This section contains Mbed TLS build settings that are not associated
3538 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003539 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003540 * \{
3541 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003542
Gilles Peskinea02c1242022-03-16 17:03:19 +01003543/**
3544 * \def MBEDTLS_CONFIG_FILE
3545 *
3546 * If defined, this is a header which will be included instead of
3547 * `"mbedtls/mbedtls_config.h"`.
3548 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003549 * Unlike other configuration options, this one must be defined on the
3550 * compiler command line: a definition in `mbedtls_config.h` would have
3551 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003552 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003553 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003554 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003555 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003556 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003557 * The value of this symbol is typically a path in double quotes, either
3558 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003559 */
3560//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3561
3562/**
3563 * \def MBEDTLS_USER_CONFIG_FILE
3564 *
3565 * If defined, this is a header which will be included after
3566 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003567 * This allows you to modify the default configuration, including the ability
3568 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003569 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003570 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003571 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003572 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003573 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003574 * The value of this symbol is typically a path in double quotes, either
3575 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003576 */
3577//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3578
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003579/**
3580 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3581 *
3582 * If defined, this is a header which will be included instead of
3583 * `"psa/crypto_config.h"`.
3584 * This header file specifies which cryptographic mechanisms are available
3585 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3586 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3587 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003588 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003589 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003590 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003591 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003592 * The value of this symbol is typically a path in double quotes, either
3593 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003594 */
3595//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3596
3597/**
3598 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3599 *
3600 * If defined, this is a header which will be included after
3601 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003602 * This allows you to modify the default configuration, including the ability
3603 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003604 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003605 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003606 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003607 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003608 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003609 * The value of this symbol is typically a path in double quotes, either
3610 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003611 */
3612//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3613
Gilles Peskineb1176f22023-02-22 22:07:28 +01003614/**
3615 * \def MBEDTLS_PSA_CRYPTO_PLATFORM_FILE
3616 *
3617 * If defined, this is a header which will be included instead of
3618 * `"psa/crypto_platform.h"`. This file should declare the same identifiers
3619 * as the one in Mbed TLS, but with definitions adapted to the platform on
3620 * which the library code will run.
3621 *
3622 * \note The required content of this header can vary from one version of
3623 * Mbed TLS to the next. Integrators who provide an alternative file
3624 * should review the changes in the original file whenever they
3625 * upgrade Mbed TLS.
3626 *
3627 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3628 * non-standard feature of the C language, so this feature is only available
3629 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3630 *
3631 * The value of this symbol is typically a path in double quotes, either
3632 * absolute or relative to a directory on the include search path.
3633 */
3634//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
3635
3636/**
3637 * \def MBEDTLS_PSA_CRYPTO_STRUCT_FILE
3638 *
3639 * If defined, this is a header which will be included instead of
3640 * `"psa/crypto_struct.h"`. This file should declare the same identifiers
3641 * as the one in Mbed TLS, but with definitions adapted to the environment
3642 * in which the library code will run. The typical use for this feature
3643 * is to provide alternative type definitions on the client side in
3644 * client-server integrations of PSA crypto, where operation structures
3645 * contain handles instead of cryptographic data.
3646 *
3647 * \note The required content of this header can vary from one version of
3648 * Mbed TLS to the next. Integrators who provide an alternative file
3649 * should review the changes in the original file whenever they
3650 * upgrade Mbed TLS.
3651 *
3652 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
3653 * non-standard feature of the C language, so this feature is only available
3654 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
3655 *
3656 * The value of this symbol is typically a path in double quotes, either
3657 * absolute or relative to a directory on the include search path.
3658 */
3659//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
3660
Gilles Peskineba4162a2022-04-11 17:04:38 +02003661/** \} name SECTION: General configuration options */
3662
3663/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003664 * \name SECTION: Module configuration options
3665 *
3666 * This section allows for the setting of module specific sizes and
3667 * configuration options. The default values are already present in the
3668 * relevant header files and should suffice for the regular use cases.
3669 *
3670 * Our advice is to enable options and change their values here
3671 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003672 * \{
3673 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003674/* The Doxygen documentation here is used when a user comments out a
3675 * setting and runs doxygen themselves. On the other hand, when we typeset
3676 * the full documentation including disabled settings, the documentation
3677 * in specific modules' header files is used if present. When editing this
3678 * file, make sure that each option is documented in exactly one place,
3679 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3680 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003681
Paul Bakker088c5c52014-04-25 11:11:10 +02003682/* MPI / BIGNUM options */
Andrzej Kurek86f30ff2023-02-24 07:44:57 -05003683//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003684//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003685
Paul Bakker088c5c52014-04-25 11:11:10 +02003686/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003687//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3688//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3689//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3690//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3691//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003692
Paul Bakker088c5c52014-04-25 11:11:10 +02003693/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3695//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3696//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3697//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003698
Paul Bakker088c5c52014-04-25 11:11:10 +02003699/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003700//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003701//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003702
Paul Bakker088c5c52014-04-25 11:11:10 +02003703/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003704//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3705//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003706//#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 +01003707
Paul Bakker088c5c52014-04-25 11:11:10 +02003708/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003710
Paul Bakker088c5c52014-04-25 11:11:10 +02003711/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003712//#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 +02003713//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003714//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003715//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003716//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003717//#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 +02003718//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3719//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003720/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003721//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003722//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3723//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003724//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3725//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3726//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003727
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003728/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3729/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003730//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3732//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003733//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003734//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3735//#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 +02003736//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3737//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003738/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003739//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003740//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003741//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3742//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Jerry Yuf181e542023-02-23 17:16:26 +08003743//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t //#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t /**< Default milliseconds time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled. It must be signed, and at least 64 bits. If it is changed from the default, MBEDTLS_PRINTF_MS_TIME must be updated to match.*/
Jerry Yu10ce5402023-02-21 15:39:02 +08003744//#define MBEDTLS_PRINTF_MS_TIME PRId64 /**< Default fmt for printf. That's avoid compiler warning if mbedtls_ms_time_t is redefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003745
Gilles Peskine3f106f72021-09-23 17:42:39 +02003746/** \def MBEDTLS_CHECK_RETURN
3747 *
3748 * This macro is used at the beginning of the declaration of a function
3749 * to indicate that its return value should be checked. It should
3750 * instruct the compiler to emit a warning or an error if the function
3751 * is called without checking its return value.
3752 *
3753 * There is a default implementation for popular compilers in platform_util.h.
3754 * You can override the default implementation by defining your own here.
3755 *
3756 * If the implementation here is empty, this will effectively disable the
3757 * checking of functions' return values.
3758 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003759//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003760
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003761/** \def MBEDTLS_IGNORE_RETURN
3762 *
3763 * This macro requires one argument, which should be a C function call.
3764 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3765 * warning is suppressed.
3766 */
3767//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3768
Gilles Peskineed038902020-11-13 21:33:21 +01003769/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003770/**
Gilles Peskineed038902020-11-13 21:33:21 +01003771 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3772 * PSA crypto subsystem.
3773 *
3774 * If this option is unset:
3775 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003776 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003777 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3778 * on unspecified heuristics.
3779 */
3780//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3781
Steven Cooreman863470a2021-02-15 14:03:19 +01003782/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003783 * Restrict the PSA library to supporting a maximum amount of simultaneously
3784 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3785 * volatile key, or a persistent key which is loaded temporarily by the
3786 * library as part of a crypto operation in flight.
3787 *
3788 * If this option is unset, the library will fall back to a default value of
3789 * 32 keys.
3790 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003791//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003792
Paul Bakker088c5c52014-04-25 11:11:10 +02003793/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003794//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3795//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003796
Paul Bakker088c5c52014-04-25 11:11:10 +02003797/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003798
Angus Grattond8213d02016-05-25 20:56:48 +10003799/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3800 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003801 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003802 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003803 * This determines the size of the incoming TLS I/O buffer in such a way
3804 * that it is capable of holding the specified amount of plaintext data,
3805 * regardless of the protection mechanism used.
3806 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003807 * \note When using a value less than the default of 16KB on the client, it is
3808 * recommended to use the Maximum Fragment Length (MFL) extension to
3809 * inform the server about this limitation. On the server, there
3810 * is no supported, standardized way of informing the client about
3811 * restriction on the maximum size of incoming messages, and unless
3812 * the limitation has been communicated by other means, it is recommended
3813 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3814 * while keeping the default value of 16KB for the incoming buffer.
3815 *
David Horstmann95d516f2021-05-04 18:36:56 +01003816 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003817 */
3818//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3819
Gilles Peskined3d02902020-03-04 21:35:27 +01003820/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3821 *
3822 * The maximum length of CIDs used for incoming DTLS messages.
3823 *
3824 */
3825//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3826
3827/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3828 *
3829 * The maximum length of CIDs used for outgoing DTLS messages.
3830 *
3831 */
3832//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3833
TRodziewicze8dd7092021-05-12 14:19:11 +02003834/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003835 *
3836 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003837 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003838 *
3839 * The padding will always be chosen so that the length of the
3840 * padded plaintext is a multiple of the value of this option.
3841 *
3842 * Note: A value of \c 1 means that no padding will be used
3843 * for outgoing records.
3844 *
3845 * Note: On systems lacking division instructions,
3846 * a power of two should be preferred.
3847 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003848//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003849
Angus Grattond8213d02016-05-25 20:56:48 +10003850/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3851 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003852 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003853 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003854 * This determines the size of the outgoing TLS I/O buffer in such a way
3855 * that it is capable of holding the specified amount of plaintext data,
3856 * regardless of the protection mechanism used.
3857 *
Angus Grattond8213d02016-05-25 20:56:48 +10003858 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3859 * the default inward 16384 byte buffer to conform to the TLS specification.
3860 *
3861 * The minimum required outward buffer size is determined by the handshake
3862 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3863 * The specific size requirement depends on the configured ciphers and any
3864 * certificate data which is sent during the handshake.
3865 *
David Horstmann95d516f2021-05-04 18:36:56 +01003866 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003867 */
3868//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3869
Hanno Beckere0b150f2018-08-21 15:51:03 +01003870/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3871 *
3872 * Maximum number of heap-allocated bytes for the purpose of
3873 * DTLS handshake message reassembly and future message buffering.
3874 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003875 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003876 * to account for a reassembled handshake message of maximum size,
3877 * together with its reassembly bitmap.
3878 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003879 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003880 * should be sufficient for all practical situations as it allows
3881 * to reassembly a large handshake message (such as a certificate)
3882 * while buffering multiple smaller handshake messages.
3883 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003884 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003885//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003886
Ronald Cron1aa6e8d2023-02-23 09:46:54 +01003887//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 or 384 bits) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003888//#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 +02003889
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003890/**
3891 * Complete list of ciphersuites to use, in order of preference.
3892 *
3893 * \warning No dependency checking is done on that field! This option can only
3894 * be used to restrict the set of available ciphersuites. It is your
3895 * responsibility to make sure the needed modules are active.
3896 *
3897 * Use this to save a few hundred bytes of ROM (default ordering of all
3898 * available ciphersuites) and a few to a few hundred bytes of RAM.
3899 *
3900 * The value below is only an example, not the default.
3901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003902//#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 +02003903
Gilles Peskinea8d7e432022-08-04 23:39:41 +02003904/**
3905 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
3906 *
3907 * Maximum time difference in milliseconds tolerated between the age of a
3908 * ticket from the server and client point of view.
3909 * From the client point of view, the age of a ticket is the time difference
3910 * between the time when the client proposes to the server to use the ticket
3911 * (time of writing of the Pre-Shared Key Extension including the ticket) and
3912 * the time the client received the ticket from the server.
3913 * From the server point of view, the age of a ticket is the time difference
3914 * between the time when the server receives a proposition from the client
3915 * to use the ticket and the time when the ticket was created by the server.
3916 * The server age is expected to be always greater than the client one and
3917 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
3918 * maximum difference tolerated for the server to accept the ticket.
3919 * This is not used in TLS 1.2.
3920 *
3921 */
3922#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
3923
3924/**
3925 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
3926 *
3927 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
3928 *
3929 * This must be less than 256.
3930 */
3931#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
3932
3933/**
3934 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
3935 *
3936 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
3937 * after handshake completion. This is not used in TLS 1.2 and relevant only if
3938 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
3939 *
3940 */
3941#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
3942
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003943/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003944//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003945//#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 +01003946
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003947/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003948 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003949 * mbedtls_platform_zeroize(). This replaces the default implementation in
3950 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003951 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003952 * mbedtls_platform_zeroize() is a widely used function across the library to
3953 * zero a block of memory. The implementation is expected to be secure in the
3954 * sense that it has been written to prevent the compiler from removing calls
3955 * to mbedtls_platform_zeroize() as part of redundant code elimination
3956 * optimizations. However, it is difficult to guarantee that calls to
3957 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3958 * versions of the C language standards do not provide a secure implementation
3959 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3960 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003961 * example by using directives specific to their compiler, features from newer
3962 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003963 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003964 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003965//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003966
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003967/**
3968 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003969 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003970 * platform_util.c.
3971 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003972 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003973 * library will try to use safer implementations of this function, such as
3974 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003975 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003976 * using the standard gmtime(). In this case, calls from the library to
3977 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003978 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003979 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003980 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3981 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3982 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003983 */
Hanno Becker6a739782018-09-05 15:06:19 +01003984//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003985
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003986/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003987 * Enable the verified implementations of ECDH primitives from Project Everest
3988 * (currently only Curve25519). This feature changes the layout of ECDH
3989 * contexts and therefore is a compatibility break for applications that access
3990 * fields of a mbedtls_ecdh_context structure directly. See also
3991 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003992 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003993//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003994
Aditya Deshpandee41f7e42023-01-12 16:29:02 +00003995/**
3996 * Uncomment to enable p256-m, which implements ECC key generation, ECDH,
3997 * and ECDSA for SECP256R1 curves. This driver is used as an example to
3998 * document how a third-party driver or software accelerator can be integrated
3999 * to work alongside Mbed TLS.
4000 *
Aditya Deshpandebac592d2023-02-14 14:55:49 +00004001 * \warning p256-m has only been included to serve as a sample implementation
4002 * of how a driver/accelerator can be integrated alongside Mbed TLS. It is not
Aditya Deshpandef100f002023-03-21 14:49:31 +00004003 * intended for use in production. p256-m files in Mbed TLS are not updated
4004 * regularly, so they may not contain upstream fixes/improvements.
Aditya Deshpandee41f7e42023-01-12 16:29:02 +00004005 * DO NOT ENABLE/USE THIS MACRO IN PRODUCTION BUILDS!
4006 */
4007//#define MBEDTLS_P256M_EXAMPLE_DRIVER_ENABLED
4008
Gilles Peskine611179c2022-04-13 23:04:48 +02004009/** \} name SECTION: Module configuration options */