blob: 23e601b32da0f62ab77bcf8a3984202df8372bf6 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02002 * \file mbedtls_config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief Configuration options (set of defines)
5 *
Simon Butcher5b331b92016-01-03 16:14:14 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020025 */
26
Bence Szépkúti2bb74562021-06-21 16:19:00 +020027/**
Tom Cosgrove1e211442022-05-26 11:51:00 +010028 * This is an optional version symbol that enables compatibility handling of
Bence Szépkúti2bb74562021-06-21 16:19:00 +020029 * config files.
30 *
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010031 * It is equal to the #MBEDTLS_VERSION_NUMBER of the Mbed TLS version that
Bence Szépkúti2bb74562021-06-21 16:19:00 +020032 * introduced the config format we want to be compatible with.
33 */
Bence Szépkúti1cafe5c2021-06-22 09:30:08 +020034//#define MBEDTLS_CONFIG_VERSION 0x03000000
Bence Szépkútiba7248a2021-05-31 16:53:56 +020035
Paul Bakkerf3b86c12011-01-27 15:24:17 +000036/**
Paul Bakker0a62cd12011-01-21 11:00:08 +000037 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
Paul Bakkerf3b86c12011-01-27 15:24:17 +000043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044 * \def MBEDTLS_HAVE_ASM
Paul Bakkerf3b86c12011-01-27 15:24:17 +000045 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020046 * The compiler has support for asm().
Paul Bakker68041ec2009-04-19 21:17:55 +000047 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010051 * library/aria.c
Chris Jones4c5819c2021-03-03 17:45:34 +000052 * library/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000053 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010054 * Required by:
55 * MBEDTLS_AESNI_C
56 * MBEDTLS_PADLOCK_C
57 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020058 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000059 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000061
Paul Bakkerf3b86c12011-01-27 15:24:17 +000062/**
Gilles Peskineed942f82017-06-08 15:19:20 +020063 * \def MBEDTLS_NO_UDBL_DIVISION
64 *
65 * The platform lacks support for double-width integer division (64-bit
66 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
67 *
68 * Used in:
69 * include/mbedtls/bignum.h
70 * library/bignum.c
71 *
72 * The bignum code uses double-width division to speed up some operations.
73 * Double-width division is often implemented in software that needs to
74 * be linked with the program. The presence of a double-width integer
75 * type is usually detected automatically through preprocessor macros,
76 * but the automatic detection cannot know whether the code needs to
77 * and can be linked with an implementation of division for that type.
78 * By default division is assumed to be usable if the type is present.
79 * Uncomment this option to prevent the use of double-width division.
80 *
81 * Note that division for the native integer type is always required.
82 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garcia2801d002017-07-21 10:56:22 +010083 * platform, but it need not support multiplication or division. In some
84 * cases it is also desirable to disable some double-width operations. For
85 * example, if double-width division is implemented in software, disabling
86 * it can reduce code size in some embedded targets.
Gilles Peskineed942f82017-06-08 15:19:20 +020087 */
88//#define MBEDTLS_NO_UDBL_DIVISION
89
90/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020091 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
92 *
93 * The platform lacks support for 32x32 -> 64-bit multiplication.
94 *
95 * Used in:
96 * library/poly1305.c
97 *
98 * Some parts of the library may use multiplication of two unsigned 32-bit
99 * operands with a 64-bit result in order to speed up computations. On some
100 * platforms, this is not available in hardware and has to be implemented in
101 * software, usually in a library provided by the toolchain.
102 *
103 * Sometimes it is not desirable to have to link to that library. This option
104 * removes the dependency of that library on platforms that lack a hardware
105 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
106 *
107 * Note that depending on the compiler, this may decrease performance compared
108 * to using the library function provided by the toolchain.
109 */
110//#define MBEDTLS_NO_64BIT_MULTIPLICATION
111
112/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200113 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000114 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000115 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000116 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000117 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200119//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200120
121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200122 * \def MBEDTLS_HAVE_TIME
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200123 *
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200124 * System has time.h and time().
125 * The time does not need to be correct, only time differences are used,
126 * by contrast with MBEDTLS_HAVE_TIME_DATE
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200127 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100128 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
129 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
130 * MBEDTLS_PLATFORM_STD_TIME.
131 *
Andrzej Kurek57353692022-04-07 08:08:21 -0400132 * Comment if your system does not support time functions.
133 *
134 * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing
135 * interface - timing.c will include time.h on suitable platforms
136 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
137 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_HAVE_TIME
Manuel Pégourié-Gonnard10934de2013-12-13 12:54:09 +0100140
141/**
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200142 * \def MBEDTLS_HAVE_TIME_DATE
143 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100144 * System has time.h, time(), and an implementation for
145 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100146 * The time needs to be correct (not necessarily very accurate, but at least
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200147 * the date should be correct). This is used to verify the validity period of
148 * X.509 certificates.
149 *
150 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100151 *
Hanno Becker6a739782018-09-05 15:06:19 +0100152 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100153 * behaves similarly to the gmtime_r() function from the C standard. Refer to
154 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100155 *
156 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100157 * mbedtls_platform_gmtime_r() at compile-time by using the macro
158 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Manuel Pégourié-Gonnard60c793b2015-06-18 20:52:58 +0200159 */
160#define MBEDTLS_HAVE_TIME_DATE
161
162/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 *
165 * Enable the memory allocation layer.
166 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200167 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100168 * This allows different allocators (self-implemented or provided) to be
169 * provided to the platform abstraction layer.
170 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200172 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
173 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * free() function pointer at runtime.
175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200177 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000178 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100179 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181 *
182 * Enable this layer to allow use of alternative memory allocators.
183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100185
186/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200188 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200189 * Do not assign standard functions in the platform layer (e.g. calloc() to
190 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200191 *
192 * This makes sure there are no linking errors on platforms that do not support
193 * these functions. You will HAVE to provide alternatives, either at runtime
194 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
196 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200197 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200199 *
200 * Uncomment to prevent default assignment of standard functions in the
201 * platform layer.
202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200204
205/**
Janos Follathc351d182016-03-21 08:43:59 +0000206 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100207 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100208 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
209 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
212 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100213 * alternative printf function pointer.
214 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100216 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200217 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
218 * it will be enabled automatically by check_config.h
219 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200220 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000222 *
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +0100223 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
224 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100225 * Uncomment a macro to enable alternate implementation of specific base
226 * platform function
227 */
Gilles Peskine6497b5a2022-06-30 17:01:40 +0200228//#define MBEDTLS_PLATFORM_SETBUF_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200229//#define MBEDTLS_PLATFORM_EXIT_ALT
SimonBd5800b72016-04-26 07:43:27 +0100230//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200231//#define MBEDTLS_PLATFORM_FPRINTF_ALT
232//#define MBEDTLS_PLATFORM_PRINTF_ALT
233//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200234//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100235//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garcia59c20262017-07-18 10:23:04 +0100236//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100237
238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100240 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000241 * Mark deprecated functions and features so that they generate a warning if
242 * used. Functionality deprecated in one version will usually be removed in the
243 * next version. You can enable this to help you prepare the transition to a
244 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100245 *
246 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200247 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100248 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000249 * Uncomment to get warnings on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100252
253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100255 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000256 * Remove deprecated functions and features so that they generate an error if
257 * used. Functionality deprecated in one version will usually be removed in the
258 * next version. You can enable this to help you prepare the transition to a
259 * new major version by making sure your code is not using this functionality.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100260 *
Andres Amaya Garcia09634242018-11-29 09:55:41 +0000261 * Uncomment to get errors on using deprecated functions and features.
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100264
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100265/** \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000266
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000267/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000268 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000269 *
270 * This section sets support for features that are or are not needed
271 * within the modules that are enabled.
272 * \{
273 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000275/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276 * \def MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100277 *
TRodziewiczd8540832021-06-10 15:16:50 +0200278 * Uncomment to provide your own alternate implementation for
Manuel Pégourié-Gonnarda63bc942015-05-14 18:22:47 +0200279 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
Paul Bakkerf2561b32014-02-06 15:11:55 +0100280 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281 * Only works if you have MBEDTLS_TIMING_C enabled.
Paul Bakkerf2561b32014-02-06 15:11:55 +0100282 *
283 * You will need to provide a header "timing_alt.h" and an implementation at
284 * compile time.
285 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286//#define MBEDTLS_TIMING_ALT
Paul Bakkerf2561b32014-02-06 15:11:55 +0100287
288/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100289 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200290 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100291 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100292 * alternate core implementation of a symmetric crypto, an arithmetic or hash
293 * module (e.g. platform specific assembly optimized implementations). Keep
294 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200295 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200296 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200297 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000300 * provide the "struct mbedtls_aes_context" definition and omit the base
301 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200302 * "aes.h" to include the new function definitions.
303 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200304 * Uncomment a macro to enable alternate implementation of the corresponding
305 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100306 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200307 * \warning MD5, DES and SHA-1 are considered weak and their
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100308 * use constitutes a security risk. If possible, we recommend
309 * avoiding dependencies on them, and considering stronger message
310 * digests and ciphers instead.
311 *
Paul Bakker90995b52013-06-24 19:20:35 +0200312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313//#define MBEDTLS_AES_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000314//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200316//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300317//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200318//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200319//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000321//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000322//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100323//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300324//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300326//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000328//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329//#define MBEDTLS_SHA1_ALT
330//#define MBEDTLS_SHA256_ALT
331//#define MBEDTLS_SHA512_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000332
Janos Follathb0697532016-08-18 12:38:46 +0100333/*
Shaun Case8b0ecbc2021-12-20 21:14:10 -0800334 * When replacing the elliptic curve module, please consider, that it is
Janos Follathb0697532016-08-18 12:38:46 +0100335 * implemented with two .c files:
336 * - ecp.c
337 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000338 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
339 * macros as described above. The only difference is that you have to make sure
340 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100341 */
342//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200343
344/**
TRodziewicz75628d52021-06-18 12:56:27 +0200345 * \def MBEDTLS_SHA256_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200346 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100347 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
348 * alternate core implementation of symmetric crypto or hash function. Keep in
349 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200350 *
351 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200353 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
355 * no longer provide the mbedtls_sha1_process() function, but it will still provide
356 * the other function (using your mbedtls_sha1_process() function) and the definition
357 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200358 * with this definition.
359 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +0200360 * \note If you use the AES_xxx_ALT macros, then it is recommended to also set
Hanno Beckera5723f42017-06-26 12:46:19 +0100361 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
362 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200363 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200364 * Uncomment a macro to enable alternate implementation of the corresponding
365 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100366 *
TRodziewicz10e8cf52021-05-31 17:58:57 +0200367 * \warning MD5, DES and SHA-1 are considered weak and their use
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100368 * constitutes a security risk. If possible, we recommend avoiding
369 * dependencies on them, and considering stronger message digests
370 * and ciphers instead.
371 *
Janos Follath1231d212019-01-07 15:01:32 +0000372 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
373 * enabled, then the deterministic ECDH signature functions pass the
374 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
375 * alternative implementations should use the RNG only for generating
376 * the ephemeral key and nothing else. If this is not possible, then
377 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
TRodziewiczc1c479f2021-05-06 00:53:22 +0200378 * implementation should be provided for mbedtls_ecdsa_sign_det_ext().
Janos Follath1231d212019-01-07 15:01:32 +0000379 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200380 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381//#define MBEDTLS_MD5_PROCESS_ALT
382//#define MBEDTLS_RIPEMD160_PROCESS_ALT
383//#define MBEDTLS_SHA1_PROCESS_ALT
384//#define MBEDTLS_SHA256_PROCESS_ALT
385//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200386//#define MBEDTLS_DES_SETKEY_ALT
387//#define MBEDTLS_DES_CRYPT_ECB_ALT
388//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200389//#define MBEDTLS_AES_SETKEY_ENC_ALT
390//#define MBEDTLS_AES_SETKEY_DEC_ALT
391//#define MBEDTLS_AES_ENCRYPT_ALT
392//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300393//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300394//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300395//#define MBEDTLS_ECDSA_VERIFY_ALT
396//#define MBEDTLS_ECDSA_SIGN_ALT
397//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200398
399/**
Janos Follathc44ab972016-11-18 16:38:23 +0000400 * \def MBEDTLS_ECP_INTERNAL_ALT
401 *
402 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100403 *
404 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100405 * alternative core implementation of elliptic curve arithmetic. Keep in mind
406 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100407 *
408 * This partially replaces one function. The header file from mbed TLS is still
409 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
410 * is still present and it is used for group structures not supported by the
411 * alternative.
412 *
Steven Cooreman97b49842021-01-08 16:32:20 +0100413 * The original implementation can in addition be removed by setting the
Steven Cooreman6226a122021-01-21 13:58:31 +0100414 * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the
Steven Cooreman97b49842021-01-08 16:32:20 +0100415 * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be
416 * able to fallback to curves not supported by the alternative implementation.
417 *
Janos Follathc44ab972016-11-18 16:38:23 +0000418 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
419 * and implementing the following functions:
420 * unsigned char mbedtls_internal_ecp_grp_capable(
421 * const mbedtls_ecp_group *grp )
422 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500423 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000424 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
425 * replacement functions implement arithmetic for the given group and 0
426 * otherwise.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500427 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000428 * called before and after each point operation and provide an opportunity to
429 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100430 *
Steven Cooreman6226a122021-01-21 13:58:31 +0100431 * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and
432 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac()
433 * function, but will use your mbedtls_internal_ecp_double_jac() if the group
434 * for the operation is supported by your implementation (i.e. your
435 * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the
436 * group is not supported by your implementation, then the original mbed TLS
437 * implementation of ecp_double_jac() is used instead, unless this fallback
438 * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case
439 * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE).
440 *
441 * The function prototypes and the definition of mbedtls_ecp_group and
442 * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your
443 * implementation of mbedtls_internal_ecp__function_name__ must be compatible
444 * with their definitions.
Janos Follathb0697532016-08-18 12:38:46 +0100445 *
446 * Uncomment a macro to enable alternate implementation of the corresponding
447 * function.
448 */
449/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000450//#define MBEDTLS_ECP_INTERNAL_ALT
Steven Cooreman97b49842021-01-08 16:32:20 +0100451/* Turn off software fallback for curves not supported in hardware */
452//#define MBEDTLS_ECP_NO_FALLBACK
Janos Follathb0697532016-08-18 12:38:46 +0100453/* Support for Weierstrass curves with Jacobi representation */
454//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
455//#define MBEDTLS_ECP_ADD_MIXED_ALT
456//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
457//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
458//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
459/* Support for curves with Montgomery arithmetic */
460//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
461//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
462//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
463
464/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200465 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200466 *
467 * Uncomment this macro to let mbed TLS use your own implementation of a
468 * hardware entropy collector.
469 *
470 * Your function must be called \c mbedtls_hardware_poll(), have the same
Chris Jones3848e312021-03-11 16:17:59 +0000471 * prototype as declared in library/entropy_poll.h, and accept NULL as first
472 * argument.
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200473 *
474 * Uncomment to use your own hardware entropy collector.
475 */
476//#define MBEDTLS_ENTROPY_HARDWARE_ALT
477
478/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200479 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000480 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100481 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000482 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100483 * Uncomment this macro to use precomputed AES tables stored in ROM.
484 * Comment this macro to generate AES tables in RAM at runtime.
485 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100486 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
487 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100488 * initialization time before the first AES operation can be performed.
489 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
490 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
491 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100492 *
493 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
494 *
Paul Bakker15566e42011-04-24 21:19:15 +0000495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000497
498/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100499 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200500 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100501 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200502 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100503 * Uncommenting this macro omits 75% of the AES tables from
504 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
505 * by computing their values on the fly during operations
506 * (the tables are entry-wise rotations of one another).
507 *
508 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100509 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100510 * runtime. Specifically, one has to compare 4 accesses within
511 * different tables to 4 accesses with additional arithmetic
512 * operations within the same table. The performance gain/loss
513 * depends on the system and memory details.
514 *
515 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
516 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200517 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100518//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200519
520/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200522 *
523 * Use less ROM for the Camellia implementation (saves about 768 bytes).
524 *
525 * Uncomment this macro to use less memory for Camellia.
526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200528
529/**
Gilles Peskine9a7d4c22021-09-23 18:07:36 +0200530 * \def MBEDTLS_CHECK_RETURN_WARNING
531 *
532 * If this macro is defined, emit a compile-time warning if application code
533 * calls a function without checking its return value, but the return value
534 * should generally be checked in portable applications.
535 *
536 * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is
537 * implemented. Otherwise this option has no effect.
538 *
539 * Uncomment to get warnings on using fallible functions without checking
540 * their return value.
541 *
542 * \note This feature is a work in progress.
543 * Warnings will be added to more functions in the future.
544 *
545 * \note A few functions are considered critical, and ignoring the return
546 * value of these functions will trigger a warning even if this
547 * macro is not defined. To completely disable return value check
548 * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion.
549 */
550//#define MBEDTLS_CHECK_RETURN_WARNING
551
552/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200554 *
555 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
556 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200557#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200558
559/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000561 *
562 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
563 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000565
566/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000568 *
569 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
570 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000572
573/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100574 * \def MBEDTLS_CIPHER_MODE_OFB
575 *
576 * Enable Output Feedback mode (OFB) for symmetric ciphers.
577 */
578#define MBEDTLS_CIPHER_MODE_OFB
579
580/**
581 * \def MBEDTLS_CIPHER_MODE_XTS
582 *
583 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
584 */
585#define MBEDTLS_CIPHER_MODE_XTS
586
587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000589 *
590 * Enable NULL cipher.
591 * Warning: Only do so when you know what you are doing. This allows for
592 * encryption or channels without any security!
593 *
Ronald Croncee42702021-04-26 11:34:44 +0200594 * To enable the following ciphersuites:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200595 * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA
596 * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA
597 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA
598 * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA
599 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384
600 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256
601 * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA
602 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384
603 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256
604 * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA
605 * MBEDTLS_TLS_RSA_WITH_NULL_SHA256
606 * MBEDTLS_TLS_RSA_WITH_NULL_SHA
607 * MBEDTLS_TLS_RSA_WITH_NULL_MD5
608 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384
609 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256
610 * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA
611 * MBEDTLS_TLS_PSK_WITH_NULL_SHA384
612 * MBEDTLS_TLS_PSK_WITH_NULL_SHA256
613 * MBEDTLS_TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000614 *
615 * Uncomment this macro to enable the NULL cipher and ciphersuites
Paul Bakkerfab5c822012-02-06 16:45:10 +0000616 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000618
619/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100620 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200621 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100622 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
623 * specific padding modes in the cipher layer with cipher modes that support
624 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200625 *
626 * If you disable all padding modes, only full blocks can be used with CBC.
627 *
628 * Enable padding modes in the cipher layer.
629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200630#define MBEDTLS_CIPHER_PADDING_PKCS7
631#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
632#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
633#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200634
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200635/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
636 *
637 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
638 * By default, CTR_DRBG uses a 256-bit key.
639 */
640//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
641
Paul Bakker48e93c82013-08-14 12:21:18 +0200642/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100643 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200644 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100645 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
646 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200647 *
648 * Comment macros to disable the curve and functions for it
649 */
Gilles Peskine799e5762018-09-14 17:34:00 +0200650/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200651#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
654#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
655#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
656#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
657#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
658#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
659#define MBEDTLS_ECP_DP_BP256R1_ENABLED
660#define MBEDTLS_ECP_DP_BP384R1_ENABLED
661#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Gilles Peskine799e5762018-09-14 17:34:00 +0200662/* Montgomery curves (supporting ECP) */
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200663#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000664#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200665
666/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200667 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200668 *
669 * Enable specific 'modulo p' routines for each NIST prime.
670 * Depending on the prime and architecture, makes operations 4 to 8 times
671 * faster on the corresponding curve.
672 *
673 * Comment this macro to disable NIST curves optimisation.
674 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200675#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200676
677/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200678 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100679 *
680 * Enable "non-blocking" ECC operations that can return early and be resumed.
681 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200682 * This allows various functions to pause by returning
683 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module,
684 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in
685 * order to further progress and eventually complete their operation. This is
686 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum
687 * number of ECC operations a function may perform before pausing; see
688 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100689 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200690 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200691 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100692 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200693 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200694 *
Ron Eldor19779c42018-11-05 16:58:13 +0200695 * \note This option only works with the default software implementation of
696 * elliptic curve functionality. It is incompatible with
Thomas Daubney537e6432021-06-03 15:46:33 +0100697 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100698 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200699//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100700
701/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200702 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100703 *
704 * Enable deterministic ECDSA (RFC 6979).
705 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
706 * may result in a compromise of the long-term signing key. This is avoided by
707 * the deterministic variant.
708 *
John Durkop36a82e52020-10-26 09:39:05 -0700709 * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100710 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100711 * Comment this macro to disable deterministic ECDSA.
712 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100714
715/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716 * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200717 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200718 * Enable the PSK based ciphersuite modes in SSL / TLS.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200719 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200720 * This enables the following ciphersuites (if other requisites are
721 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
723 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
724 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
725 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
726 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
727 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
728 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
729 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
730 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
731 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200732 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200734
735/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736 * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200737 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200738 * Enable the DHE-PSK based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200739 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200740 * Requires: MBEDTLS_DHM_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200741 *
742 * This enables the following ciphersuites (if other requisites are
743 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200744 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
745 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
746 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
747 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
748 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
749 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
750 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
751 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
752 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
753 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Hanno Beckera2f6b722017-09-28 10:33:29 +0100754 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100755 * \warning Using DHE constitutes a security risk as it
756 * is not possible to validate custom DH parameters.
757 * If possible, it is recommended users should consider
758 * preferring other methods of key exchange.
759 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100760 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200766 *
767 * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS.
768 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769 * Requires: MBEDTLS_ECDH_C
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200770 *
771 * This enables the following ciphersuites (if other requisites are
772 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
774 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
775 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
776 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
777 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
778 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200779 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
Manuel Pégourié-Gonnard3ce3bbd2013-10-11 16:53:50 +0200781
782/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200784 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200785 * Enable the RSA-PSK based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard0fae60b2013-10-14 17:39:48 +0200786 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200787 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
788 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200789 *
790 * This enables the following ciphersuites (if other requisites are
791 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200792 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
793 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
794 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
795 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
796 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
797 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
798 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
799 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
800 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
801 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200804
805/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806 * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200807 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200808 * Enable the RSA-only based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200809 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
811 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200812 *
813 * This enables the following ciphersuites (if other requisites are
814 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200815 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
816 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
817 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
818 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
819 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
820 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
821 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
822 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
823 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
824 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
825 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
826 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
Paul Bakkere07f41d2013-04-19 09:08:57 +0200827 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200828#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200829
830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831 * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200833 * Enable the DHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200834 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835 * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
836 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200837 *
838 * This enables the following ciphersuites (if other requisites are
839 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
841 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
842 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
843 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
844 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
845 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
846 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
847 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
848 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
849 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
850 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
851 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
Hanno Beckera2f6b722017-09-28 10:33:29 +0100852 *
Hanno Beckerf9734b32017-10-03 12:09:22 +0100853 * \warning Using DHE constitutes a security risk as it
854 * is not possible to validate custom DH parameters.
855 * If possible, it is recommended users should consider
856 * preferring other methods of key exchange.
857 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +0100858 *
Paul Bakkere07f41d2013-04-19 09:08:57 +0200859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200861
862/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200863 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200864 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200865 * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS.
Paul Bakkere07f41d2013-04-19 09:08:57 +0200866 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15,
868 * MBEDTLS_X509_CRT_PARSE_C
Paul Bakkere07f41d2013-04-19 09:08:57 +0200869 *
870 * This enables the following ciphersuites (if other requisites are
871 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
873 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
874 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
875 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
876 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
877 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
878 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
879 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
880 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
881 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakkere07f41d2013-04-19 09:08:57 +0200882 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Paul Bakkere07f41d2013-04-19 09:08:57 +0200884
885/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200886 * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200887 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200888 * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS.
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200889 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200890 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C,
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200891 *
892 * This enables the following ciphersuites (if other requisites are
893 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200894 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
895 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
896 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
897 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
898 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
899 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
900 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
901 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
902 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
903 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200905#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Manuel Pégourié-Gonnard32ea60a2013-08-17 17:39:04 +0200906
907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100909 *
910 * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS.
911 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200912 * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100913 *
914 * This enables the following ciphersuites (if other requisites are
915 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
917 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
918 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
919 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
920 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
921 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
922 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
923 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
924 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
925 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100926 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100928
929/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930 * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100931 *
932 * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS.
933 *
Gilles Peskine7ab66a62018-09-14 17:47:41 +0200934 * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100935 *
936 * This enables the following ciphersuites (if other requisites are
937 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
939 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
940 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
941 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
942 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
943 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
944 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
945 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
946 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
947 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200949#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
Manuel Pégourié-Gonnard25781b22013-12-11 16:17:10 +0100950
951/**
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200952 * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
953 *
954 * Enable the ECJPAKE based ciphersuite modes in SSL / TLS.
955 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +0200956 * \warning This is currently experimental. EC J-PAKE support is based on the
957 * Thread v1.0.0 specification; incompatible changes to the specification
958 * might still happen. For this reason, this is disabled by default.
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200959 *
960 * Requires: MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnardb4e28aa2022-09-19 11:55:00 +0200961 * SHA-256 (via MD if present, or via PSA, see MBEDTLS_ECJPAKE_C)
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200962 * MBEDTLS_ECP_DP_SECP256R1_ENABLED
963 *
964 * This enables the following ciphersuites (if other requisites are
965 * enabled as well):
966 * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8
967 */
Manuel Pégourié-Gonnardcf828932015-10-20 14:57:00 +0200968//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200969
970/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200971 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100972 *
973 * Enhance support for reading EC keys using variants of SEC1 not allowed by
974 * RFC 5915 and RFC 5480.
975 *
976 * Currently this means parsing the SpecifiedECDomain choice of EC
977 * parameters (only known groups are supported, not arbitrary domains, to
978 * avoid validation issues).
979 *
980 * Disable if you only need to support RFC 5915 + 5480 key formats.
981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200982#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100983
984/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200985 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * Enable a dummy error function to make use of mbedtls_strerror() in
988 * third party libraries easier when MBEDTLS_ERROR_C is disabled
989 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
992 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100993 *
994 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200995 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100998
999/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001001 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001002 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +00001007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001009 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001010 *
1011 * Enable functions that use the filesystem.
1012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +00001014
1015/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001016 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001017 *
TRodziewicz15a7b732021-06-16 11:22:53 +02001018 * Do not add default entropy sources in mbedtls_entropy_init().
Paul Bakker43655f42011-12-15 20:11:16 +00001019 *
Shuo Chen95a0d112014-04-04 21:04:40 -07001020 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +00001021 * application.
1022 *
1023 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +00001024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001025//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +00001026
1027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001029 *
1030 * Do not use built-in platform entropy functions.
1031 * This is useful if your platform does not support
1032 * standards like the /dev/urandom or Windows CryptoAPI.
1033 *
1034 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +00001035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +00001037
1038/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001040 *
1041 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
1042 * default SHA-512 based one (if both are available).
1043 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001044 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +01001045 *
1046 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
1047 * if you have performance concerns.
1048 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001049 * This option is only useful if both MBEDTLS_SHA256_C and
1050 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +01001051 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001052//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +01001053
1054/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001055 * \def MBEDTLS_ENTROPY_NV_SEED
1056 *
1057 * Enable the non-volatile (NV) seed file-based entropy source.
1058 * (Also enables the NV seed read/write functions in the platform layer)
1059 *
1060 * This is crucial (if not required) on systems that do not have a
1061 * cryptographic entropy source (in hardware or kernel) available.
1062 *
1063 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
1064 *
Paul Bakker71a597a2016-06-07 10:59:03 +01001065 * \note The read/write functions that are used by the entropy source are
1066 * determined in the platform layer, and can be modified at runtime and/or
1067 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
1068 *
1069 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001070 * with regular fopen(), please make sure you make a seedfile with the
1071 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
1072 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +01001073 * and written to or you will get an entropy source error! The default
1074 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
1075 * bytes from the file.
1076 *
1077 * \note The entropy collector will write to the seed file before entropy is
1078 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001079 */
1080//#define MBEDTLS_ENTROPY_NV_SEED
1081
Ronald Cron71016a92020-08-28 19:01:50 +02001082/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001083 *
Ronald Cron71016a92020-08-28 19:01:50 +02001084 * Enable key identifiers that encode a key owner identifier.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001085 *
Ronald Cron9a2511e2020-09-14 10:02:56 +02001086 * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t
1087 * which is currently hard-coded to be int32_t.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001088 *
1089 * Note that this option is meant for internal use only and may be removed
Andrzej Kurekcfc920a2022-01-25 06:33:08 -05001090 * without notice.
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001091 */
Ronald Cron71016a92020-08-28 19:01:50 +02001092//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Gilles Peskine69d7c8b2019-02-19 14:00:31 +01001093
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001094/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001095 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001096 *
1097 * Enable debugging of buffer allocator memory issues. Automatically prints
1098 * (to stderr) all (fatal) messages on memory allocation issues. Enables
1099 * function for 'debug output' of allocated memory.
1100 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001102 *
1103 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +02001104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +02001106
1107/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001108 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001109 *
1110 * Include backtrace information with each allocated block.
1111 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Tom Cosgrovece7f18c2022-07-28 05:50:56 +01001113 * GLIBC-compatible backtrace() and backtrace_symbols() support
Paul Bakker6e339b52013-07-03 13:37:05 +02001114 *
1115 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +02001116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +02001118
1119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001121 *
1122 * Support external private RSA keys (eg from a HSM) in the PK layer.
1123 *
1124 * Comment this macro to disable support for external private RSA keys.
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +02001127
1128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001129 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001130 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001131 * Enable support for PKCS#1 v1.5 encoding.
1132 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02001133 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +02001134 *
Paul Bakker48377d92013-08-30 12:06:24 +02001135 * This enables support for PKCS#1 v1.5 operations.
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +02001138
1139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001141 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001142 * Enable support for PKCS#1 v2.1 encoding.
1143 *
Manuel Pégourié-Gonnard077ba842022-07-27 10:42:31 +02001144 * Requires: MBEDTLS_RSA_C and (MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C).
1145 *
1146 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
1147 * before doing any PKCS#1 v2.1 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00001148 *
Paul Bakker9dcc3222011-03-08 14:16:06 +00001149 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
1150 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +00001152
Steven Cooreman6801f082021-02-19 17:21:22 +01001153/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1154 *
1155 * Enable support for platform built-in keys. If you enable this feature,
1156 * you must implement the function mbedtls_psa_platform_get_builtin_key().
1157 * See the documentation of that function for more information.
1158 *
1159 * Built-in keys are typically derived from a hardware unique key or
1160 * stored in a secure element.
1161 *
1162 * Requires: MBEDTLS_PSA_CRYPTO_C.
1163 *
1164 * \warning This interface is experimental and may change or be removed
1165 * without notice.
1166 */
1167//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
1168
Ronald Cron3768ac12021-01-26 16:58:00 +01001169/** \def MBEDTLS_PSA_CRYPTO_CLIENT
1170 *
1171 * Enable support for PSA crypto client.
1172 *
1173 * \note This option allows to include the code necessary for a PSA
1174 * crypto client when the PSA crypto implementation is not included in
1175 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the
1176 * code to set and get PSA key attributes.
1177 * The development of PSA drivers partially relying on the library to
1178 * fulfill the hardware gaps is another possible usage of this option.
1179 *
1180 * \warning This interface is experimental and may change or be removed
1181 * without notice.
1182 */
1183//#define MBEDTLS_PSA_CRYPTO_CLIENT
1184
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001185/** \def MBEDTLS_PSA_CRYPTO_DRIVERS
1186 *
1187 * Enable support for the experimental PSA crypto driver interface.
1188 *
John Durkop185764f2020-10-12 21:32:12 -07001189 * Requires: MBEDTLS_PSA_CRYPTO_C
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001190 *
Gilles Peskine4b873872022-06-20 18:50:09 +02001191 * \warning This interface is experimental. We intend to maintain backward
1192 * compatibility with application code that relies on drivers,
1193 * but the driver interfaces may change without notice.
Steven Cooreman0d59f7b02020-07-16 20:27:57 +02001194 */
1195//#define MBEDTLS_PSA_CRYPTO_DRIVERS
1196
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001197/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1198 *
1199 * Make the PSA Crypto module use an external random generator provided
1200 * by a driver, instead of Mbed TLS's entropy and DRBG modules.
1201 *
Gilles Peskineb663a602020-11-18 15:27:37 +01001202 * \note This random generator must deliver random numbers with cryptographic
1203 * quality and high performance. It must supply unpredictable numbers
1204 * with a uniform distribution. The implementation of this function
1205 * is responsible for ensuring that the random generator is seeded
1206 * with sufficient entropy. If you have a hardware TRNG which is slow
1207 * or delivers non-uniform output, declare it as an entropy source
1208 * with mbedtls_entropy_add_source() instead of enabling this option.
1209 *
Gilles Peskineb0a748e2020-11-30 12:01:54 +01001210 * If you enable this option, you must configure the type
Gilles Peskineb8af2282020-11-13 18:00:34 +01001211 * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h
1212 * and define a function called mbedtls_psa_external_get_random()
1213 * with the following prototype:
Gilles Peskinef08b3f82020-11-13 17:36:48 +01001214 * ```
1215 * psa_status_t mbedtls_psa_external_get_random(
1216 * mbedtls_psa_external_random_context_t *context,
1217 * uint8_t *output, size_t output_size, size_t *output_length);
1218 * );
1219 * ```
1220 * The \c context value is initialized to 0 before the first call.
1221 * The function must fill the \c output buffer with \p output_size bytes
1222 * of random data and set \c *output_length to \p output_size.
1223 *
1224 * Requires: MBEDTLS_PSA_CRYPTO_C
1225 *
1226 * \warning If you enable this option, code that uses the PSA cryptography
1227 * interface will not use any of the entropy sources set up for
1228 * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED
1229 * enables.
1230 *
1231 * \note This option is experimental and may be removed without notice.
1232 */
1233//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
1234
Paul Bakker9dcc3222011-03-08 14:16:06 +00001235/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05001236 * \def MBEDTLS_PSA_CRYPTO_SPM
1237 *
1238 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
1239 * Partition Manager) integration which separates the code into two parts: a
1240 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
1241 * Environment).
1242 *
1243 * Module: library/psa_crypto.c
1244 * Requires: MBEDTLS_PSA_CRYPTO_C
1245 *
1246 */
1247//#define MBEDTLS_PSA_CRYPTO_SPM
1248
1249/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001250 * \def MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001251 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001252 * Enable support for entropy injection at first boot. This feature is
1253 * required on systems that do not have a built-in entropy source (TRNG).
1254 * This feature is currently not supported on systems that have a built-in
1255 * entropy source.
Andrzej Kurekc6905232019-02-05 05:23:41 -05001256 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001257 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Andrzej Kurekc6905232019-02-05 05:23:41 -05001258 *
1259 */
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00001260//#define MBEDTLS_PSA_INJECT_ENTROPY
Andrzej Kurekc6905232019-02-05 05:23:41 -05001261
1262/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001264 *
Hanno Becker88ec2382017-05-03 13:51:16 +01001265 * Do not use the Chinese Remainder Theorem
1266 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001267 *
1268 * Uncomment this macro to disable the use of CRT in RSA.
1269 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001272
1273/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001275 *
1276 * Enable the checkup functions (*_self_test).
1277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001279
1280/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001281 * \def MBEDTLS_SHA256_SMALLER
1282 *
1283 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1284 * lower performance.
1285 *
Adam Wolf039080f2019-09-10 09:53:08 -05001286 * The default implementation is meant to be a reasonable compromise between
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001287 * performance and size. This version optimizes more aggressively for size at
1288 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1289 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1290 * 30%.
1291 *
1292 * Uncomment to enable the smaller implementation of SHA256.
1293 */
1294//#define MBEDTLS_SHA256_SMALLER
1295
1296/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001297 * \def MBEDTLS_SHA512_SMALLER
1298 *
1299 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1300 * lower performance.
1301 *
1302 * Uncomment to enable the smaller implementation of SHA512.
1303 */
1304//#define MBEDTLS_SHA512_SMALLER
1305
1306/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307 * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001308 *
1309 * Enable sending of alert messages in case of encountered errors as per RFC.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001310 * If you choose not to send the alert messages, mbed TLS can still communicate
Paul Bakker40865c82013-01-31 17:13:13 +01001311 * with other servers, only debugging of failures is harder.
1312 *
1313 * The advantage of not sending alert messages, is that no information is given
1314 * about reasons for failures thus preventing adversaries of gaining intel.
1315 *
1316 * Enable sending of all alert messages
1317 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Paul Bakker40865c82013-01-31 17:13:13 +01001319
1320/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001321 * \def MBEDTLS_SSL_DTLS_CONNECTION_ID
1322 *
1323 * Enable support for the DTLS Connection ID extension
1324 * (version draft-ietf-tls-dtls-connection-id-05,
1325 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05)
1326 * which allows to identify DTLS connections across changes
1327 * in the underlying transport.
1328 *
1329 * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`,
Paul Elliott0113cf12022-03-11 20:26:47 +00001330 * mbedtls_ssl_get_own_cid()`, `mbedtls_ssl_get_peer_cid()` and
1331 * `mbedtls_ssl_conf_cid()`. See the corresponding documentation for
1332 * more information.
Gilles Peskined3d02902020-03-04 21:35:27 +01001333 *
1334 * \warning The Connection ID extension is still in draft state.
1335 * We make no stability promises for the availability
1336 * or the shape of the API controlled by this option.
1337 *
1338 * The maximum lengths of outgoing and incoming CIDs can be configured
1339 * through the options
1340 * - MBEDTLS_SSL_CID_OUT_LEN_MAX
1341 * - MBEDTLS_SSL_CID_IN_LEN_MAX.
1342 *
1343 * Requires: MBEDTLS_SSL_PROTO_DTLS
1344 *
1345 * Uncomment to enable the Connection ID extension.
1346 */
1347//#define MBEDTLS_SSL_DTLS_CONNECTION_ID
1348
1349/**
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001350 * \def MBEDTLS_SSL_ASYNC_PRIVATE
1351 *
1352 * Enable asynchronous external private key operations in SSL. This allows
1353 * you to configure an SSL connection to call an external cryptographic
1354 * module to perform private key operations instead of performing the
1355 * operation inside the library.
1356 *
1357 */
Jaeden Amerod9c71da2018-06-15 20:31:26 +01001358//#define MBEDTLS_SSL_ASYNC_PRIVATE
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001359
1360/**
Gilles Peskined3d02902020-03-04 21:35:27 +01001361 * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION
1362 *
1363 * Enable serialization of the TLS context structures, through use of the
1364 * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load().
1365 *
1366 * This pair of functions allows one side of a connection to serialize the
1367 * context associated with the connection, then free or re-use that context
1368 * while the serialized state is persisted elsewhere, and finally deserialize
1369 * that state to a live context for resuming read/write operations on the
1370 * connection. From a protocol perspective, the state of the connection is
1371 * unaffected, in particular this is entirely transparent to the peer.
1372 *
1373 * Note: this is distinct from TLS session resumption, which is part of the
1374 * protocol and fully visible by the peer. TLS session resumption enables
1375 * establishing new connections associated to a saved session with shorter,
1376 * lighter handshakes, while context serialization is a local optimization in
1377 * handling a single, potentially long-lived connection.
1378 *
1379 * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are
1380 * saved after the handshake to allow for more efficient serialization, so if
1381 * you don't need this feature you'll save RAM by disabling it.
1382 *
Przemek Stekiel460192e2022-10-03 08:55:29 +02001383 * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C
1384 *
Gilles Peskined3d02902020-03-04 21:35:27 +01001385 * Comment to disable the context serialization APIs.
1386 */
1387#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1388
1389/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001391 *
1392 * Enable the debug messages in SSL module for all issues.
1393 * Debug messages have been disabled in some places to prevent timing
1394 * attacks due to (unbalanced) debugging function calls.
1395 *
1396 * If you need all error reporting you should enable this during debugging,
1397 * but remove this for production servers that should log as well.
1398 *
1399 * Uncomment this macro to report all debug messages on errors introducing
1400 * a timing side-channel.
1401 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001402 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001404
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001405/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001406 *
1407 * Enable support for Encrypt-then-MAC, RFC 7366.
1408 *
1409 * This allows peers that both support it to use a more robust protection for
1410 * ciphersuites using CBC, providing deep resistance against timing attacks
1411 * on the padding or underlying cipher.
1412 *
1413 * This only affects CBC ciphersuites, and is useless if none is defined.
1414 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001415 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001416 *
1417 * Comment this macro to disable support for Encrypt-then-MAC
1418 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001422 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001423 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1424 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001425 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001426 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001427 * attacks, but it is recommended to always use it (even if you disable
1428 * renegotiation), since it actually fixes a more fundamental issue in the
1429 * original SSL/TLS design, and has implications beyond Triple Handshake.
1430 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001431 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001432 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001433 * Comment this macro to disable support for Extended Master Secret.
1434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001435#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001436
Paul Bakkerd66f0702013-01-31 16:57:45 +01001437/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001438 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1439 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001440 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001441 * giving access to the peer's certificate after completion of the handshake.
1442 *
1443 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1444 * recommended to disable this option for reduced RAM usage.
1445 *
1446 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1447 * defined, but always returns \c NULL.
1448 *
1449 * \note This option has no influence on the protection against the
1450 * triple handshake attack. Even if it is disabled, Mbed TLS will
1451 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001452 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001453 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001454 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1455 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001456 * Comment this macro to disable storing the peer's certificate
1457 * after the handshake.
1458 */
1459#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1460
1461/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001462 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001463 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001464 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001465 *
1466 * The two main uses of renegotiation are (1) refresh keys on long-lived
1467 * connections and (2) client authentication after the initial handshake.
1468 * If you don't need renegotiation, it's probably better to disable it, since
1469 * it has been associated with security issues in the past and is easy to
1470 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001471 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001472 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001473 *
1474 * \note Even if this option is disabled, both client and server are aware
1475 * of the Renegotiation Indication Extension (RFC 5746) used to
1476 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1477 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1478 * configuration of this extension).
1479 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001480 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001481#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001482
1483/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001485 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001486 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001487 *
1488 * Comment this macro to disable support for the max_fragment_length extension
1489 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001491
1492/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001494 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001495 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001496 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001497 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1498 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1499 * With MBEDTLS_USE_PSA_CRYPTO:
1500 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1501 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001502 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001503 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1504 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001505 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001506 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001507 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001509
1510/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001511 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001512 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001513 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001514 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001515 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1516 * pre-shared keys are not supported.
1517 * See docs/architecture/tls13-support.md for a description of the TLS
1518 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001519 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001520 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001521 * Requires: MBEDTLS_PSA_CRYPTO_C
1522 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001523 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1524 * for most operations, if you want it to only use PSA for all crypto
1525 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1526 * operations, and functions that are common with TLS 1.2 (record protection,
1527 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001528 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001529 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001530 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001531//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001532
1533/**
Ronald Cronab65c522021-11-24 10:47:20 +01001534 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1535 *
1536 * Enable TLS 1.3 middlebox compatibility mode.
1537 *
1538 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1539 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1540 * expecting TLS 1.2 traffic.
1541 *
1542 * Turning on the compatibility mode comes at the cost of a few added bytes
1543 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1544 * that don't use it. Therefore, unless transmission bandwidth is critical and
1545 * you know that middlebox compatibility issues won't occur, it is therefore
1546 * recommended to set this option.
1547 *
1548 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001549 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1550 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001551 *
1552 */
1553//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1554
1555/**
Jerry Yu6cf85a42022-09-13 11:14:42 +08001556 * \def MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE
Jerry Yu0038c5f2022-07-07 06:49:01 +00001557 *
Jerry Yu6cf85a42022-09-13 11:14:42 +08001558 * Maximum time difference in milliseconds tolerated between the age of a
1559 * ticket from the server and client point of view.
1560 * From the client point of view, the age of a ticket is the time difference
1561 * between the time when the client proposes to the server to use the ticket
1562 * (time of writing of the Pre-Shared Key Extension including the ticket) and
1563 * the time the client received the ticket from the server.
1564 * From the server point of view, the age of a ticket is the time difference
1565 * between the time when the server receives a proposition from the client
1566 * to use the ticket and the time when the ticket was created by the server.
1567 * The server age is expected to be always greater than the client one and
1568 * MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE defines the
1569 * maximum difference tolerated for the server to accept the ticket.
1570 * This is not used in TLS 1.2.
Jerry Yu89eb95a2022-08-21 19:21:45 +08001571 *
1572 */
1573#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
1574
1575/**
Jerry Yu0038c5f2022-07-07 06:49:01 +00001576 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
1577 *
1578 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1579 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001580 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001581 */
Jerry Yu9750f812022-07-20 11:04:50 +08001582#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001583
1584/**
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001585 * \def MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS
1586 *
Jerry Yuf3bdf9d2022-09-22 23:30:49 +08001587 * Default number of NewSessionTicket messages to be sent by a TLS 1.3 server
1588 * after handshake completion. This is not used in TLS 1.2 and relevant only if
1589 * the MBEDTLS_SSL_SESSION_TICKETS option is enabled.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001590 *
1591 */
1592#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
1593
1594/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001596 *
1597 * Enable support for DTLS (all available versions).
1598 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001599 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001600 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001601 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001602 *
1603 * Comment this macro to disable support for DTLS
1604 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001605#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001606
1607/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001608 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001609 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001610 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001611 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001612 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001614#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001615
1616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001618 *
1619 * Enable support for the anti-replay mechanism in DTLS.
1620 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001621 * Requires: MBEDTLS_SSL_TLS_C
1622 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001623 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001624 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001625 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001626 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001627 * Comment this to disable anti-replay in DTLS.
1628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001630
1631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001633 *
1634 * Enable support for HelloVerifyRequest on DTLS servers.
1635 *
1636 * This feature is highly recommended to prevent DTLS servers being used as
1637 * amplifiers in DoS attacks against other hosts. It should always be enabled
1638 * unless you know for sure amplification cannot be a problem in the
1639 * environment in which your server operates.
1640 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001641 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001642 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001643 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001644 *
1645 * Comment this to disable support for HelloVerifyRequest.
1646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001647#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001648
1649/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001650 * \def MBEDTLS_SSL_DTLS_SRTP
1651 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001652 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001653 * through the use_srtp extension.
1654 *
1655 * \note This feature provides the minimum functionality required
1656 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1657 * the associated SRTP packet protection key material.
1658 * In particular, the SRTP packet protection itself, as well as the
1659 * demultiplexing of RTP and DTLS packets at the datagram layer
1660 * (see Section 5 of RFC 5764), are not handled by this feature.
1661 * Instead, after successful completion of a handshake negotiating
1662 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001663 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001664 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1665 * (this is implemented in the SSL example programs).
1666 * The resulting key should then be passed to an SRTP stack.
1667 *
1668 * Setting this option enables the runtime API
1669 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1670 * through which the supported DTLS-SRTP protection
1671 * profiles can be configured. You must call this API at
1672 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001673 *
1674 * Requires: MBEDTLS_SSL_PROTO_DTLS
1675 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001676 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001677 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001678//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001679
1680/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001681 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1682 *
1683 * Enable server-side support for clients that reconnect from the same port.
1684 *
1685 * Some clients unexpectedly close the connection and try to reconnect using the
1686 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001687 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001688 * flag enables that support.
1689 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001690 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001691 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001692 * Comment this to disable support for clients reusing the source port.
1693 */
1694#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1695
1696/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001698 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001699 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001700 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001701 * session store remains the responsibility of the application, though).
1702 * Server-side, you also need to provide callbacks for writing and parsing
1703 * tickets, including authenticated encryption and key management. Example
1704 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001705 *
1706 * Comment this macro to disable support for SSL session tickets
1707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001709
1710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001712 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001713 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001714 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001715 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001716 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001717 * Comment this macro to disable support for server name indication in SSL
1718 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001720
1721/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001722 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1723 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001724 * When this option is enabled, the SSL buffer will be resized automatically
1725 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001726 *
1727 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001728 */
1729//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1730
1731/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001732 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1733 *
1734 * Enable testing of the constant-flow nature of some sensitive functions with
1735 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001736 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001737 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001738 * This setting requires compiling with clang -fsanitize=memory. The test
1739 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001740 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001741 * \warning This macro is only used for extended testing; it is not considered
1742 * part of the library's API, so it may change or disappear at any time.
1743 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001744 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001745 */
1746//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1747
1748/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001749 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1750 *
1751 * Enable testing of the constant-flow nature of some sensitive functions with
1752 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001753 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001754 *
1755 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001756 * testing if the tests suites are run with valgrind's memcheck. This can be
1757 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1758 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001759 *
1760 * \warning This macro is only used for extended testing; it is not considered
1761 * part of the library's API, so it may change or disappear at any time.
1762 *
1763 * Uncomment to enable testing of the constant-flow nature of selected code.
1764 */
1765//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1766
1767/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001768 * \def MBEDTLS_TEST_HOOKS
1769 *
1770 * Enable features for invasive testing such as introspection functions and
1771 * hooks for fault injection. This enables additional unit tests.
1772 *
1773 * Merely enabling this feature should not change the behavior of the product.
1774 * It only adds new code, and new branching points where the default behavior
1775 * is the same as when this feature is disabled.
1776 * However, this feature increases the attack surface: there is an added
1777 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1778 * Therefore this feature must never be enabled in production.
1779 *
1780 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1781 * information.
1782 *
1783 * Uncomment to enable invasive tests.
1784 */
1785//#define MBEDTLS_TEST_HOOKS
1786
1787/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001789 *
1790 * Provide your own alternate threading implementation.
1791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001792 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001793 *
1794 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001796//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001797
1798/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001799 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001800 *
1801 * Enable the pthread wrapper layer for the threading layer.
1802 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001803 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001804 *
1805 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001807//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001808
1809/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001810 * \def MBEDTLS_USE_PSA_CRYPTO
1811 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001812 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1813 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001814 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001815 * \note Development of this option is currently in progress, and parts of Mbed
1816 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001817 * will still continue to work as usual, so enabling this option should not
1818 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001819 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001820 * \note See docs/use-psa-crypto.md for a complete description of what this
1821 * option currently does, and of parts that are not affected by it so far.
1822 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001823 * \warning If you enable this option, you need to call `psa_crypto_init()`
1824 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001825 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001826 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001827 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001828 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001829 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001830 */
1831//#define MBEDTLS_USE_PSA_CRYPTO
1832
1833/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001834 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1835 *
John Durkop185764f2020-10-12 21:32:12 -07001836 * This setting allows support for cryptographic mechanisms through the PSA
1837 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001838 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001839 * When this option is disabled, the PSA API exposes the cryptographic
1840 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1841 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001842 *
1843 * When this option is enabled, the PSA API exposes the cryptographic
1844 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1845 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1846 * automatically enabled if required (i.e. if no PSA driver provides the
1847 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1848 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001849 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001850 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001851 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001852 *
John Durkop185764f2020-10-12 21:32:12 -07001853 * This feature is still experimental and is not ready for production since
1854 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001855 */
1856//#define MBEDTLS_PSA_CRYPTO_CONFIG
1857
1858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001860 *
1861 * Allow run-time checking of compile-time enabled features. Thus allowing users
1862 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001864 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001865 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001866 *
1867 * Comment this to disable run-time checking and save ROM space
1868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001870
1871/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001872 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1873 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001874 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001875 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1876 * the set of trusted certificates through a callback instead of a linked
1877 * list.
1878 *
1879 * This is useful for example in environments where a large number of trusted
1880 * certificates is present and storing them in a linked list isn't efficient
1881 * enough, or when the set of trusted certificates changes frequently.
1882 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001883 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001884 * `mbedtls_ssl_conf_ca_cb()` for more information.
1885 *
1886 * Uncomment to enable trusted certificate callbacks.
1887 */
1888//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1889
1890/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001891 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001892 *
Chris Jones2c745862020-12-16 11:41:06 +00001893 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001894 *
Chris Jones2c745862020-12-16 11:41:06 +00001895 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001896 * and other functions/constants only used by these functions, thus reducing
1897 * the code footprint by several KB.
1898 */
Chris Jones2c745862020-12-16 11:41:06 +00001899//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001903 *
1904 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1905 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1906 *
1907 * Comment this macro to disallow using RSASSA-PSS in certificates.
1908 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01001910/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001911
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001912/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001913 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001914 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001915 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001916 * \{
1917 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001918
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001919/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001921 *
1922 * Enable AES-NI support on x86-64.
1923 *
1924 * Module: library/aesni.c
1925 * Caller: library/aes.c
1926 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001927 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001928 *
1929 * This modules adds support for the AES-NI instructions on x86-64
1930 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001931#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001932
1933/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001935 *
1936 * Enable the AES block cipher.
1937 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001938 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001939 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001940 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001941 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001942 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00001943 * This module enables the following ciphersuites (if other requisites are
1944 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1946 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1947 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1948 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1949 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1950 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1951 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1952 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1953 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1954 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1955 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1956 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1957 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1958 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1959 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1960 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1961 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1962 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1963 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1964 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1965 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1966 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1967 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1968 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1969 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1970 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1971 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1972 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1973 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1974 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1975 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1976 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1977 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1978 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1979 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1980 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1981 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1982 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1983 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1984 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1985 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1986 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1987 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1988 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1989 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1990 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1991 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1992 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1993 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1994 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1995 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1996 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1997 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
1998 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
1999 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
2000 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
2001 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
2002 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01002003 *
Paul Bakkercff68422013-09-15 20:43:33 +02002004 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00002005 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002006#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002007
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002008/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002010 *
2011 * Enable the generic ASN1 parser.
2012 *
2013 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002014 * Caller: library/x509.c
2015 * library/dhm.c
2016 * library/pkcs12.c
2017 * library/pkcs5.c
2018 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00002019 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00002021
2022/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002024 *
2025 * Enable the generic ASN1 writer.
2026 *
2027 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002028 * Caller: library/ecdsa.c
2029 * library/pkwrite.c
2030 * library/x509_create.c
2031 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002032 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002035
2036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002038 *
2039 * Enable the Base64 module.
2040 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002041 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002042 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002043 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002044 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002045 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002047
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002048/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002049 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002050 *
Paul Bakker9a736322012-11-14 12:39:52 +00002051 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002052 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002053 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002054 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002055 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002056 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002057 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002058 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002059 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002060 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002061 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002062 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002063 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002064 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002065 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002067
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002070 *
2071 * Enable the Camellia block cipher.
2072 *
Paul Bakker38119b12009-01-10 23:31:23 +00002073 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002074 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002075 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002076 * This module enables the following ciphersuites (if other requisites are
2077 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2079 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2080 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2081 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2082 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2083 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2084 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2085 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2086 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2087 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2088 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2089 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2090 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2091 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2092 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2093 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2094 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2095 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2096 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2097 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2098 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2099 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2100 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2101 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2102 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2103 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2104 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2105 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2106 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2107 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2108 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2109 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2110 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2111 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2112 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2113 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2114 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2115 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2116 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2117 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2118 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2119 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002121#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002122
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002123/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002124 * \def MBEDTLS_ARIA_C
2125 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002126 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002127 *
2128 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002129 * Caller: library/cipher.c
2130 *
2131 * This module enables the following ciphersuites (if other requisites are
2132 * enabled as well):
2133 *
2134 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2135 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2136 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2137 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2138 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2140 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2141 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2142 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2143 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2144 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2145 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2146 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2147 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2148 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2149 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2150 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2151 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2152 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2153 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2154 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2155 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2156 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2157 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2158 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2159 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2160 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2161 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2162 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2163 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2164 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2165 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2166 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2167 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2168 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2169 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2170 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2171 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002172 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002173#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002174
2175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002177 *
2178 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2179 *
2180 * Module: library/ccm.c
2181 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002182 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2183 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002184 *
2185 * This module enables the AES-CCM ciphersuites, if other requisites are
2186 * enabled as well.
2187 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002188#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002189
2190/**
Daniel King34b822c2016-05-15 17:28:08 -03002191 * \def MBEDTLS_CHACHA20_C
2192 *
2193 * Enable the ChaCha20 stream cipher.
2194 *
2195 * Module: library/chacha20.c
2196 */
2197#define MBEDTLS_CHACHA20_C
2198
2199/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002200 * \def MBEDTLS_CHACHAPOLY_C
2201 *
2202 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2203 *
2204 * Module: library/chachapoly.c
2205 *
2206 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2207 */
2208#define MBEDTLS_CHACHAPOLY_C
2209
2210/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002212 *
2213 * Enable the generic cipher layer.
2214 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002215 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002216 * Caller: library/ccm.c
2217 * library/cmac.c
2218 * library/gcm.c
2219 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002220 * library/pkcs12.c
2221 * library/pkcs5.c
2222 * library/psa_crypto_aead.c
2223 * library/psa_crypto_mac.c
2224 * library/ssl_ciphersuites.c
2225 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002226 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002227 *
2228 * Uncomment to enable generic cipher wrappers.
2229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002230#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002231
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002232/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002233 * \def MBEDTLS_CMAC_C
2234 *
Simon Butcher327398a2016-10-05 14:09:11 +01002235 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2236 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002237 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002238 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2239 * implementation of the CMAC algorithm is provided by an alternate
2240 * implementation, that alternate implementation may opt to not support
2241 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2242 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002243 * Module: library/cmac.c
2244 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002245 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002246 *
2247 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002248#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002249
2250/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002252 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002253 * Enable the CTR_DRBG AES-based random generator.
2254 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002255 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002256 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002257 * \note To achieve a 256-bit security strength with CTR_DRBG,
2258 * you must use AES-256 *and* use sufficient entropy.
2259 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002260 *
2261 * Module: library/ctr_drbg.c
2262 * Caller:
2263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002265 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002266 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002269
2270/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002271 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002272 *
2273 * Enable the debug functions.
2274 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002276 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002277 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002278 * library/ssl_tls12_*.c
2279 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002280 *
2281 * This module provides debugging functions.
2282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002284
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002285/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002286 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002287 *
2288 * Enable the DES block cipher.
2289 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002290 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002291 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002292 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002293 *
Paul Bakkercff68422013-09-15 20:43:33 +02002294 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002295 *
2296 * \warning DES is considered a weak cipher and its use constitutes a
2297 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002299#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002300
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002301/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002303 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002304 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002305 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002306 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002307 * Caller: library/ssl_tls.c
2308 * library/ssl*_client.c
2309 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002310 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002311 * This module is used by the following key exchanges:
2312 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002313 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002314 * \warning Using DHE constitutes a security risk as it
2315 * is not possible to validate custom DH parameters.
2316 * If possible, it is recommended users should consider
2317 * preferring other methods of key exchange.
2318 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002319 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002321#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002322
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002323/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002325 *
2326 * Enable the elliptic curve Diffie-Hellman library.
2327 *
2328 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002329 * Caller: library/psa_crypto.c
2330 * library/ssl_tls.c
2331 * library/ssl*_client.c
2332 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002333 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002334 * This module is used by the following key exchanges:
2335 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002336 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002337 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002338 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002339#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002340
2341/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002343 *
2344 * Enable the elliptic curve DSA library.
2345 *
2346 * Module: library/ecdsa.c
2347 * Caller:
2348 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002349 * This module is used by the following key exchanges:
2350 * ECDHE-ECDSA
2351 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002352 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2353 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2354 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002357
2358/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002359 * \def MBEDTLS_ECJPAKE_C
2360 *
2361 * Enable the elliptic curve J-PAKE library.
2362 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002363 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2364 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002365 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002366 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002367 * Module: library/ecjpake.c
2368 * Caller:
2369 *
2370 * This module is used by the following key exchanges:
2371 * ECJPAKE
2372 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002373 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002374 *
2375 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2376 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002377 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002378#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002379
2380/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002382 *
2383 * Enable the elliptic curve over GF(p) library.
2384 *
2385 * Module: library/ecp.c
2386 * Caller: library/ecdh.c
2387 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002388 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002389 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002392#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002393
2394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002396 *
2397 * Enable the platform-specific entropy code.
2398 *
2399 * Module: library/entropy.c
2400 * Caller:
2401 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002403 *
2404 * This module provides a generic entropy pool
2405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002407
2408/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002410 *
2411 * Enable error code to error string conversion.
2412 *
2413 * Module: library/error.c
2414 * Caller:
2415 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002417 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002419
2420/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002422 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002423 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002424 *
2425 * Module: library/gcm.c
2426 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002427 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2428 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002429 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002430 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2431 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002434
2435/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002436 * \def MBEDTLS_HKDF_C
2437 *
2438 * Enable the HKDF algorithm (RFC 5869).
2439 *
2440 * Module: library/hkdf.c
2441 * Caller:
2442 *
2443 * Requires: MBEDTLS_MD_C
2444 *
2445 * This module adds support for the Hashed Message Authentication Code
2446 * (HMAC)-based key derivation function (HKDF).
2447 */
2448#define MBEDTLS_HKDF_C
2449
2450/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002451 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002452 *
2453 * Enable the HMAC_DRBG random generator.
2454 *
2455 * Module: library/hmac_drbg.c
2456 * Caller:
2457 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002459 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002460 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002462#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002463
2464/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002465 * \def MBEDTLS_NIST_KW_C
2466 *
2467 * Enable the Key Wrapping mode for 128-bit block ciphers,
2468 * as defined in NIST SP 800-38F. Only KW and KWP modes
2469 * are supported. At the moment, only AES is approved by NIST.
2470 *
2471 * Module: library/nist_kw.c
2472 *
2473 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2474 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002475#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002476
2477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479 *
2480 * Enable the generic message digest layer.
2481 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002482 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2483 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2484 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002485 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002486 * Caller: library/constant_time.c
2487 * library/ecdsa.c
2488 * library/ecjpake.c
2489 * library/hkdf.c
2490 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002491 * library/pk.c
2492 * library/pkcs5.c
2493 * library/pkcs12.c
2494 * library/psa_crypto_ecp.c
2495 * library/psa_crypto_rsa.c
2496 * library/rsa.c
2497 * library/ssl_cookie.c
2498 * library/ssl_msg.c
2499 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002500 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002501 * library/x509_crt.c
2502 * library/x509write_crt.c
2503 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002504 *
2505 * Uncomment to enable generic message digest wrappers.
2506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002508
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002509/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002510 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002511 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002512 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002513 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002514 * Module: library/md5.c
2515 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002516 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002517 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002518 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002519 * This module is required for TLS 1.2 depending on the handshake parameters.
2520 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2521 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002522 *
2523 * \warning MD5 is considered a weak message digest and its use constitutes a
2524 * security risk. If possible, we recommend avoiding dependencies on
2525 * it, and considering stronger message digests instead.
2526 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002528#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002529
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002530/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002532 *
2533 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002534 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002535 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002536 *
2537 * Module: library/memory_buffer_alloc.c
2538 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002539 * Requires: MBEDTLS_PLATFORM_C
2540 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002541 *
2542 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002543 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002544//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002545
2546/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002548 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002549 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2550 *
Simon Butcherd567a232016-03-09 20:19:21 +00002551 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2552 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002553 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002554 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002555 * \note See also our Knowledge Base article about porting to a new
2556 * environment:
2557 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2558 *
Andres AG788aa4a2016-09-14 14:32:09 +01002559 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002560 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002561 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002564
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002565/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002566 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002567 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002568 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002569 *
2570 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002571 * Caller: library/asn1write.c
2572 * library/pkcs5.c
2573 * library/pkparse.c
2574 * library/pkwrite.c
2575 * library/rsa.c
2576 * library/x509.c
2577 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002578 * library/x509_crl.c
2579 * library/x509_crt.c
2580 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002581 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002582 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002583 *
2584 * This modules translates between OIDs and internal values.
2585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002587
2588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002590 *
2591 * Enable VIA Padlock support on x86.
2592 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002593 * Module: library/padlock.c
2594 * Caller: library/aes.c
2595 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002596 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002597 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002598 * This modules adds support for the VIA PadLock on x86.
2599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002600#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002601
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002604 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002605 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002606 *
2607 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002608 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002609 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002610 * library/x509_crl.c
2611 * library/x509_crt.c
2612 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002613 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002614 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002615 *
Paul Bakkercff68422013-09-15 20:43:33 +02002616 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002618#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002619
2620/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002621 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002622 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002623 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002624 *
2625 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002626 * Caller: library/pkwrite.c
2627 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002628 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002629 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002630 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002631 *
2632 * This modules adds support for encoding / writing PEM files.
2633 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002635
2636/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002638 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002639 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002640 *
2641 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002642 * Caller: library/psa_crypto_rsa.c
2643 * library/ssl_tls.c
2644 * library/ssl*_client.c
2645 * library/ssl*_server.c
2646 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002647 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002648 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002649 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002650 * Uncomment to enable generic public key wrappers.
2651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002653
2654/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002656 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002657 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002658 *
2659 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002660 * Caller: library/x509_crt.c
2661 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002662 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002664 *
2665 * Uncomment to enable generic public key parse functions.
2666 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002668
2669/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002670 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002671 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002672 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002673 *
2674 * Module: library/pkwrite.c
2675 * Caller: library/x509write.c
2676 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002677 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002678 *
2679 * Uncomment to enable generic public key write functions.
2680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002682
2683/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002685 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002686 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002687 *
2688 * Module: library/pkcs5.c
2689 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002690 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2691 *
2692 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2693 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002694 *
2695 * This module adds support for the PKCS#5 functions.
2696 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002697#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002698
2699/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002700 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002701 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002702 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002703 * Adds algorithms for parsing PKCS#8 encrypted private keys
2704 *
2705 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002706 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002707 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002708 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2709 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2710 *
2711 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2712 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002713 *
2714 * This module enables PKCS#12 functions.
2715 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002716#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002717
2718/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002719 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002720 *
2721 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002722 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002723 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2725 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002726 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002727 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002728 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002729 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002730 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002731 * Module: library/platform.c
2732 * Caller: Most other .c files
2733 *
2734 * This module enables abstraction of common (libc) functions.
2735 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002736#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002737
2738/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002739 * \def MBEDTLS_POLY1305_C
2740 *
2741 * Enable the Poly1305 MAC algorithm.
2742 *
2743 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002744 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002745 */
2746#define MBEDTLS_POLY1305_C
2747
2748/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002749 * \def MBEDTLS_PSA_CRYPTO_C
2750 *
2751 * Enable the Platform Security Architecture cryptography API.
2752 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002753 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002754 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002755 * Requires: MBEDTLS_CIPHER_C,
2756 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002757 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002758 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002759 *
2760 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002761#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002762
2763/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002764 * \def MBEDTLS_PSA_CRYPTO_SE_C
2765 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002766 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002767 * cryptography API.
2768 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002769 * \deprecated This feature is deprecated. Please switch to the driver
2770 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002771 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002772 * Module: library/psa_crypto_se.c
2773 *
2774 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2775 *
2776 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002777//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002778
2779/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002780 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2781 *
2782 * Enable the Platform Security Architecture persistent key storage.
2783 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002784 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002785 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002786 * Requires: MBEDTLS_PSA_CRYPTO_C,
2787 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2788 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002789 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002790#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002791
2792/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002793 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002794 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002795 * Enable the emulation of the Platform Security Architecture
2796 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002797 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002798 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002799 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002800 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002801 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002802#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002803
2804/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002806 *
2807 * Enable the RIPEMD-160 hash algorithm.
2808 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002809 * Module: library/ripemd160.c
2810 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002811 *
2812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002814
2815/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002816 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002817 *
2818 * Enable the RSA public-key cryptosystem.
2819 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002820 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002821 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002822 * Caller: library/pk.c
2823 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002824 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002825 * library/ssl*_client.c
2826 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002827 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002828 * This module is used by the following key exchanges:
2829 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002830 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002831 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002832 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002833#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002834
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002835/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002837 *
2838 * Enable the SHA1 cryptographic hash algorithm.
2839 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002840 * Module: library/sha1.c
2841 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002842 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002843 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002844 * This module is required for TLS 1.2 depending on the handshake parameters,
2845 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002846 *
2847 * \warning SHA-1 is considered a weak message digest and its use constitutes
2848 * a security risk. If possible, we recommend avoiding dependencies
2849 * on it, and considering stronger message digests instead.
2850 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002852#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002853
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002854/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002855 * \def MBEDTLS_SHA224_C
2856 *
2857 * Enable the SHA-224 cryptographic hash algorithm.
2858 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002859 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02002860 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002861 *
2862 * Module: library/sha256.c
2863 * Caller: library/md.c
2864 * library/ssl_cookie.c
2865 *
2866 * This module adds support for SHA-224.
2867 */
2868#define MBEDTLS_SHA224_C
2869
2870/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002872 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002873 * Enable the SHA-256 cryptographic hash algorithm.
2874 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002875 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002876 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002877 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002878 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002879 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002880 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002881 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002882 * library/ssl*_client.c
2883 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002884 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002885 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002886 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002887 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002889
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002890/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002891 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2892 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002893 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2894 * with the ARMv8 cryptographic extensions if they are available at runtime.
2895 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002896 *
2897 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
2898 * for a non-Aarch64 build it will be silently ignored.
2899 *
2900 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2901 * of \c -march=armv8-a+crypto.
2902 *
2903 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2904 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
2905 *
2906 * Requires: MBEDTLS_SHA256_C.
2907 *
2908 * Module: library/sha256.c
2909 *
2910 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
2911 * and use them if available.
2912 */
2913//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2914
2915/**
2916 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2917 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002918 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2919 * with the ARMv8 cryptographic extensions, which must be available at runtime
2920 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002921 *
2922 * \note This allows builds with a smaller code size than with
2923 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2924 *
2925 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2926 * of \c -march=armv8-a+crypto.
2927 *
2928 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
2929 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
2930 *
2931 * Requires: MBEDTLS_SHA256_C.
2932 *
2933 * Module: library/sha256.c
2934 *
2935 * Uncomment to have the library use the A64 SHA-256 crypto extensions
2936 * unconditionally.
2937 */
2938//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2939
2940/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002941 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002942 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002943 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002944 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002945 * Requires: MBEDTLS_SHA512_C
2946 *
2947 * Module: library/sha512.c
2948 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002949 * library/psa_crypto_hash.c
2950 * library/ssl_tls.c
2951 * library/ssl*_client.c
2952 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002953 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002954 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002955 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002956#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002957
2958/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002959 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002960 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002961 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002962 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002963 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002964 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002965 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002966 * library/ssl_tls.c
2967 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002968 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002969 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00002970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002972
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002973/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002974 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2975 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002976 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
2977 * with the ARMv8 cryptographic extensions if they are available at runtime.
2978 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002979 *
2980 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
2981 * for a non-Aarch64 build it will be silently ignored.
2982 *
2983 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
2984 * Clang >= 7, and \c CFLAGS must be set to a minimum of
2985 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
2986 * fastest code.
2987 *
2988 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2989 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
2990 *
2991 * Requires: MBEDTLS_SHA512_C.
2992 *
2993 * Module: library/sha512.c
2994 *
2995 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
2996 * and use them if available.
2997 */
2998//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2999
3000/**
3001 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3002 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02003003 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
3004 * with the ARMv8 cryptographic extensions, which must be available at runtime
3005 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00003006 *
3007 * \note This allows builds with a smaller code size than with
3008 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
3009 *
3010 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
3011 * Clang >= 7, and \c CFLAGS must be set to a minimum of
3012 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
3013 * fastest code.
3014 *
3015 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
3016 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
3017 *
3018 * Requires: MBEDTLS_SHA512_C.
3019 *
3020 * Module: library/sha512.c
3021 *
3022 * Uncomment to have the library use the A64 SHA-512 crypto extensions
3023 * unconditionally.
3024 */
3025//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
3026
3027/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003028 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003029 *
3030 * Enable simple SSL cache implementation.
3031 *
3032 * Module: library/ssl_cache.c
3033 * Caller:
3034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003035 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003036 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003038
3039/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003040 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003041 *
3042 * Enable basic implementation of DTLS cookies for hello verification.
3043 *
3044 * Module: library/ssl_cookie.c
3045 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003046 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003048
3049/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003050 * \def MBEDTLS_SSL_TICKET_C
3051 *
3052 * Enable an implementation of TLS server-side callbacks for session tickets.
3053 *
3054 * Module: library/ssl_ticket.c
3055 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003056 *
Przemek Stekiel52a428b2022-10-10 08:47:13 +02003057 * Requires: (MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO) &&
3058 * (MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C)
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003059 */
3060#define MBEDTLS_SSL_TICKET_C
3061
3062/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003064 *
3065 * Enable the SSL/TLS client code.
3066 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003067 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003068 * Caller:
3069 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003071 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003072 * This module is required for SSL/TLS client support.
3073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003075
Paul Bakker9a736322012-11-14 12:39:52 +00003076/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003078 *
3079 * Enable the SSL/TLS server code.
3080 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003081 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003082 * Caller:
3083 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003085 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003086 * This module is required for SSL/TLS server support.
3087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003089
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003091 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003092 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003093 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003094 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003095 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003096 * Caller: library/ssl*_client.c
3097 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003098 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3100 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003101 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003102 * This module is required for SSL/TLS.
3103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003105
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003106/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003107 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003108 *
3109 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003110 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003111 * contexts are not shared between threads. If you do intend to use contexts
3112 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003113 * conditions. See also our Knowledge Base article about threading:
3114 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003115 *
3116 * Module: library/threading.c
3117 *
3118 * This allows different threading implementations (self-implemented or
3119 * provided).
3120 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121 * You will have to enable either MBEDTLS_THREADING_ALT or
3122 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003123 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003124 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003126//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003127
3128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003130 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003131 * Enable the semi-portable timing interface.
3132 *
Simon Butcherd567a232016-03-09 20:19:21 +00003133 * \note The provided implementation only works on POSIX/Unix (including Linux,
3134 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003135 * module and provide your own implementations of the callbacks needed by
3136 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3137 * your own implementation of the whole module by setting
3138 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003139 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003140 * \note The timing module will include time.h on suitable platforms
3141 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3142 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3143 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003144 * \note See also our Knowledge Base article about porting to a new
3145 * environment:
3146 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3147 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003151
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003153 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003154 *
3155 * Enable run-time version information.
3156 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003157 * Module: library/version.c
3158 *
3159 * This module provides run-time version information.
3160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003162
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003165 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003166 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003167 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003168 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003169 * Caller: library/x509_crl.c
3170 * library/x509_crt.c
3171 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003172 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003173 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003174 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3175 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003176 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3177 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003178 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003179 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003182
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003183/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003185 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003186 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003187 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003188 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003189 * Caller: library/ssl_tls.c
3190 * library/ssl*_client.c
3191 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003192 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003194 *
3195 * This module is required for X.509 certificate parsing.
3196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003197#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003198
3199/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003201 *
3202 * Enable X.509 CRL parsing.
3203 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003204 * Module: library/x509_crl.c
3205 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003206 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003208 *
3209 * This module is required for X.509 CRL parsing.
3210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003211#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003212
3213/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003215 *
3216 * Enable X.509 Certificate Signing Request (CSR) parsing.
3217 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003218 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003219 * Caller: library/x509_crt_write.c
3220 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003222 *
3223 * This module is used for reading X.509 certificate request.
3224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003226
3227/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003228 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003229 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003230 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003231 *
3232 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003233 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003234 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003235 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3236 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003237 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3238 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003239 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003240 * This module is the basis for creating X.509 certificates and CSRs.
3241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003243
3244/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003246 *
3247 * Enable creating X.509 certificates.
3248 *
3249 * Module: library/x509_crt_write.c
3250 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003251 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003252 *
3253 * This module is required for X.509 certificate creation.
3254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003256
3257/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003258 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003259 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003260 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003261 *
3262 * Module: library/x509_csr_write.c
3263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003265 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003266 * This module is required for X.509 certificate request writing.
3267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003268#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003269
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003270/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003271
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003272/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003273 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003274 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003275 * This section contains Mbed TLS build settings that are not associated
3276 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003277 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003278 * \{
3279 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003280
Gilles Peskinea02c1242022-03-16 17:03:19 +01003281/**
3282 * \def MBEDTLS_CONFIG_FILE
3283 *
3284 * If defined, this is a header which will be included instead of
3285 * `"mbedtls/mbedtls_config.h"`.
3286 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003287 * Unlike other configuration options, this one must be defined on the
3288 * compiler command line: a definition in `mbedtls_config.h` would have
3289 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003290 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003291 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003292 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003293 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003294 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003295 * The value of this symbol is typically a path in double quotes, either
3296 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003297 */
3298//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3299
3300/**
3301 * \def MBEDTLS_USER_CONFIG_FILE
3302 *
3303 * If defined, this is a header which will be included after
3304 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003305 * This allows you to modify the default configuration, including the ability
3306 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003307 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003308 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003309 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003310 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003311 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003312 * The value of this symbol is typically a path in double quotes, either
3313 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003314 */
3315//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3316
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003317/**
3318 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3319 *
3320 * If defined, this is a header which will be included instead of
3321 * `"psa/crypto_config.h"`.
3322 * This header file specifies which cryptographic mechanisms are available
3323 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3324 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3325 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003326 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003327 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003328 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003329 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003330 * The value of this symbol is typically a path in double quotes, either
3331 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003332 */
3333//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3334
3335/**
3336 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3337 *
3338 * If defined, this is a header which will be included after
3339 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003340 * This allows you to modify the default configuration, including the ability
3341 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003342 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003343 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003344 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003345 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003346 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003347 * The value of this symbol is typically a path in double quotes, either
3348 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003349 */
3350//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3351
Gilles Peskineba4162a2022-04-11 17:04:38 +02003352/** \} name SECTION: General configuration options */
3353
3354/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003355 * \name SECTION: Module configuration options
3356 *
3357 * This section allows for the setting of module specific sizes and
3358 * configuration options. The default values are already present in the
3359 * relevant header files and should suffice for the regular use cases.
3360 *
3361 * Our advice is to enable options and change their values here
3362 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003363 * \{
3364 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003365/* The Doxygen documentation here is used when a user comments out a
3366 * setting and runs doxygen themselves. On the other hand, when we typeset
3367 * the full documentation including disabled settings, the documentation
3368 * in specific modules' header files is used if present. When editing this
3369 * file, make sure that each option is documented in exactly one place,
3370 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3371 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003372
Paul Bakker088c5c52014-04-25 11:11:10 +02003373/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003374//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003375//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003376
Paul Bakker088c5c52014-04-25 11:11:10 +02003377/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3379//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3380//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3381//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3382//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003383
Paul Bakker088c5c52014-04-25 11:11:10 +02003384/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003385//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3386//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3387//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3388//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003389
Paul Bakker088c5c52014-04-25 11:11:10 +02003390/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003391//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003393
Paul Bakker088c5c52014-04-25 11:11:10 +02003394/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3396//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003397//#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 +01003398
Paul Bakker088c5c52014-04-25 11:11:10 +02003399/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003401
Paul Bakker088c5c52014-04-25 11:11:10 +02003402/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003403//#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 +02003404//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003406//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003407//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003408//#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 +02003409//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3410//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003411/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003412//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003413//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3414//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003415//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3416//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3417//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003419/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3420/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003421//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3423//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003424//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003425//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3426//#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 +02003427//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3428//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003429/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003431//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003432//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3433//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003434
Gilles Peskine3f106f72021-09-23 17:42:39 +02003435/** \def MBEDTLS_CHECK_RETURN
3436 *
3437 * This macro is used at the beginning of the declaration of a function
3438 * to indicate that its return value should be checked. It should
3439 * instruct the compiler to emit a warning or an error if the function
3440 * is called without checking its return value.
3441 *
3442 * There is a default implementation for popular compilers in platform_util.h.
3443 * You can override the default implementation by defining your own here.
3444 *
3445 * If the implementation here is empty, this will effectively disable the
3446 * checking of functions' return values.
3447 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003448//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003449
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003450/** \def MBEDTLS_IGNORE_RETURN
3451 *
3452 * This macro requires one argument, which should be a C function call.
3453 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3454 * warning is suppressed.
3455 */
3456//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3457
Gilles Peskineed038902020-11-13 21:33:21 +01003458/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003459/**
Gilles Peskineed038902020-11-13 21:33:21 +01003460 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3461 * PSA crypto subsystem.
3462 *
3463 * If this option is unset:
3464 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003465 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003466 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3467 * on unspecified heuristics.
3468 */
3469//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3470
Steven Cooreman863470a2021-02-15 14:03:19 +01003471/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003472 * Restrict the PSA library to supporting a maximum amount of simultaneously
3473 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3474 * volatile key, or a persistent key which is loaded temporarily by the
3475 * library as part of a crypto operation in flight.
3476 *
3477 * If this option is unset, the library will fall back to a default value of
3478 * 32 keys.
3479 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003480//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003481
Paul Bakker088c5c52014-04-25 11:11:10 +02003482/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3484//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003485
Paul Bakker088c5c52014-04-25 11:11:10 +02003486/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003487
Angus Grattond8213d02016-05-25 20:56:48 +10003488/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3489 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003490 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003491 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003492 * This determines the size of the incoming TLS I/O buffer in such a way
3493 * that it is capable of holding the specified amount of plaintext data,
3494 * regardless of the protection mechanism used.
3495 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003496 * \note When using a value less than the default of 16KB on the client, it is
3497 * recommended to use the Maximum Fragment Length (MFL) extension to
3498 * inform the server about this limitation. On the server, there
3499 * is no supported, standardized way of informing the client about
3500 * restriction on the maximum size of incoming messages, and unless
3501 * the limitation has been communicated by other means, it is recommended
3502 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3503 * while keeping the default value of 16KB for the incoming buffer.
3504 *
David Horstmann95d516f2021-05-04 18:36:56 +01003505 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003506 */
3507//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3508
Gilles Peskined3d02902020-03-04 21:35:27 +01003509/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3510 *
3511 * The maximum length of CIDs used for incoming DTLS messages.
3512 *
3513 */
3514//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3515
3516/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3517 *
3518 * The maximum length of CIDs used for outgoing DTLS messages.
3519 *
3520 */
3521//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3522
TRodziewicze8dd7092021-05-12 14:19:11 +02003523/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003524 *
3525 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003526 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003527 *
3528 * The padding will always be chosen so that the length of the
3529 * padded plaintext is a multiple of the value of this option.
3530 *
3531 * Note: A value of \c 1 means that no padding will be used
3532 * for outgoing records.
3533 *
3534 * Note: On systems lacking division instructions,
3535 * a power of two should be preferred.
3536 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003537//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003538
Angus Grattond8213d02016-05-25 20:56:48 +10003539/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3540 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003541 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003542 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003543 * This determines the size of the outgoing TLS I/O buffer in such a way
3544 * that it is capable of holding the specified amount of plaintext data,
3545 * regardless of the protection mechanism used.
3546 *
Angus Grattond8213d02016-05-25 20:56:48 +10003547 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3548 * the default inward 16384 byte buffer to conform to the TLS specification.
3549 *
3550 * The minimum required outward buffer size is determined by the handshake
3551 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3552 * The specific size requirement depends on the configured ciphers and any
3553 * certificate data which is sent during the handshake.
3554 *
David Horstmann95d516f2021-05-04 18:36:56 +01003555 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003556 */
3557//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3558
Hanno Beckere0b150f2018-08-21 15:51:03 +01003559/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3560 *
3561 * Maximum number of heap-allocated bytes for the purpose of
3562 * DTLS handshake message reassembly and future message buffering.
3563 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003564 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003565 * to account for a reassembled handshake message of maximum size,
3566 * together with its reassembly bitmap.
3567 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003568 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003569 * should be sufficient for all practical situations as it allows
3570 * to reassembly a large handshake message (such as a certificate)
3571 * while buffering multiple smaller handshake messages.
3572 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003573 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003574//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003576//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3577//#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 +02003578
Gilles Peskine7dd2f502021-04-24 13:35:41 +02003579/** \def MBEDTLS_TLS_EXT_CID
3580 *
3581 * At the time of writing, the CID extension has not been assigned its
3582 * final value. Set this configuration option to make Mbed TLS use a
3583 * different value.
3584 *
3585 * A future minor revision of Mbed TLS may change the default value of
3586 * this option to match evolving standards and usage.
3587 */
3588//#define MBEDTLS_TLS_EXT_CID 254
3589
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003590/**
3591 * Complete list of ciphersuites to use, in order of preference.
3592 *
3593 * \warning No dependency checking is done on that field! This option can only
3594 * be used to restrict the set of available ciphersuites. It is your
3595 * responsibility to make sure the needed modules are active.
3596 *
3597 * Use this to save a few hundred bytes of ROM (default ordering of all
3598 * available ciphersuites) and a few to a few hundred bytes of RAM.
3599 *
3600 * The value below is only an example, not the default.
3601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602//#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 +02003603
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003604/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003605//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003606//#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 +01003607
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003608/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003609 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003610 * mbedtls_platform_zeroize(). This replaces the default implementation in
3611 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003612 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003613 * mbedtls_platform_zeroize() is a widely used function across the library to
3614 * zero a block of memory. The implementation is expected to be secure in the
3615 * sense that it has been written to prevent the compiler from removing calls
3616 * to mbedtls_platform_zeroize() as part of redundant code elimination
3617 * optimizations. However, it is difficult to guarantee that calls to
3618 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3619 * versions of the C language standards do not provide a secure implementation
3620 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3621 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003622 * example by using directives specific to their compiler, features from newer
3623 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003624 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003625 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003626//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003627
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003628/**
3629 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003630 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003631 * platform_util.c.
3632 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003633 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003634 * library will try to use safer implementations of this function, such as
3635 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003636 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003637 * using the standard gmtime(). In this case, calls from the library to
3638 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003639 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003640 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003641 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3642 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3643 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003644 */
Hanno Becker6a739782018-09-05 15:06:19 +01003645//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003646
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003647/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003648 * Enable the verified implementations of ECDH primitives from Project Everest
3649 * (currently only Curve25519). This feature changes the layout of ECDH
3650 * contexts and therefore is a compatibility break for applications that access
3651 * fields of a mbedtls_ecdh_context structure directly. See also
3652 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003653 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003654//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003655
Gilles Peskine611179c2022-04-13 23:04:48 +02003656/** \} name SECTION: Module configuration options */