blob: f6ecdbf5b838e693186bcbfeb84309dd870cf6bf [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 *
1383 * Comment to disable the context serialization APIs.
1384 */
1385#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
1386
1387/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388 * \def MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001389 *
1390 * Enable the debug messages in SSL module for all issues.
1391 * Debug messages have been disabled in some places to prevent timing
1392 * attacks due to (unbalanced) debugging function calls.
1393 *
1394 * If you need all error reporting you should enable this during debugging,
1395 * but remove this for production servers that should log as well.
1396 *
1397 * Uncomment this macro to report all debug messages on errors introducing
1398 * a timing side-channel.
1399 *
Paul Bakkerd66f0702013-01-31 16:57:45 +01001400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401//#define MBEDTLS_SSL_DEBUG_ALL
Paul Bakkerd66f0702013-01-31 16:57:45 +01001402
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001404 *
1405 * Enable support for Encrypt-then-MAC, RFC 7366.
1406 *
1407 * This allows peers that both support it to use a more robust protection for
1408 * ciphersuites using CBC, providing deep resistance against timing attacks
1409 * on the padding or underlying cipher.
1410 *
1411 * This only affects CBC ciphersuites, and is useless if none is defined.
1412 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001413 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001414 *
1415 * Comment this macro to disable support for Encrypt-then-MAC
1416 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001417#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001419/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001420 *
Manuel Pégourié-Gonnardbca8aa02020-03-24 12:11:49 +01001421 * Enable support for RFC 7627: Session Hash and Extended Master Secret
1422 * Extension.
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001423 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001424 * This was introduced as "the proper fix" to the Triple Handshake family of
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001425 * attacks, but it is recommended to always use it (even if you disable
1426 * renegotiation), since it actually fixes a more fundamental issue in the
1427 * original SSL/TLS design, and has implications beyond Triple Handshake.
1428 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001429 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard769c6b62014-10-28 14:13:55 +01001430 *
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001431 * Comment this macro to disable support for Extended Master Secret.
1432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001433#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001434
Paul Bakkerd66f0702013-01-31 16:57:45 +01001435/**
Hanno Beckerbb278f52019-02-05 17:04:00 +00001436 * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1437 *
Hanno Beckerfd7f2982019-02-25 10:13:33 +00001438 * This option controls the availability of the API mbedtls_ssl_get_peer_cert()
Hanno Beckerbb278f52019-02-05 17:04:00 +00001439 * giving access to the peer's certificate after completion of the handshake.
1440 *
1441 * Unless you need mbedtls_ssl_peer_cert() in your application, it is
1442 * recommended to disable this option for reduced RAM usage.
1443 *
1444 * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still
1445 * defined, but always returns \c NULL.
1446 *
1447 * \note This option has no influence on the protection against the
1448 * triple handshake attack. Even if it is disabled, Mbed TLS will
1449 * still ensure that certificates do not change during renegotiation,
Shaun Case8b0ecbc2021-12-20 21:14:10 -08001450 * for example by keeping a hash of the peer's certificate.
Hanno Beckerbb278f52019-02-05 17:04:00 +00001451 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001452 * \note This option is required if MBEDTLS_SSL_PROTO_TLS1_3 is set.
1453 *
Hanno Beckerbb278f52019-02-05 17:04:00 +00001454 * Comment this macro to disable storing the peer's certificate
1455 * after the handshake.
1456 */
1457#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
1458
1459/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 * \def MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001461 *
Hanno Becker0eb8fb82018-10-26 09:53:16 +01001462 * Enable support for TLS renegotiation.
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001463 *
1464 * The two main uses of renegotiation are (1) refresh keys on long-lived
1465 * connections and (2) client authentication after the initial handshake.
1466 * If you don't need renegotiation, it's probably better to disable it, since
1467 * it has been associated with security issues in the past and is easy to
1468 * misuse/misunderstand.
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +01001469 *
Manuel Pégourié-Gonnard55f968b2015-03-09 16:23:15 +00001470 * Comment this to disable support for renegotiation.
Hanno Becker6851b102017-10-12 14:57:48 +01001471 *
1472 * \note Even if this option is disabled, both client and server are aware
1473 * of the Renegotiation Indication Extension (RFC 5746) used to
1474 * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1).
1475 * (See \c mbedtls_ssl_conf_legacy_renegotiation for the
1476 * configuration of this extension).
1477 *
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001478 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001479#define MBEDTLS_SSL_RENEGOTIATION
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001480
1481/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001482 * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001483 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001484 * Enable support for RFC 6066 max_fragment_length extension in SSL.
Paul Bakker05decb22013-08-15 13:33:48 +02001485 *
1486 * Comment this macro to disable support for the max_fragment_length extension
1487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Paul Bakker05decb22013-08-15 13:33:48 +02001489
1490/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491 * \def MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001492 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001493 * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled).
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001494 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001495 * Requires: Without MBEDTLS_USE_PSA_CRYPTO: MBEDTLS_MD_C and
1496 * (MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C)
1497 * With MBEDTLS_USE_PSA_CRYPTO:
1498 * PSA_WANT_ALG_SHA_1 or PSA_WANT_ALG_SHA_256 or
1499 * PSA_WANT_ALG_SHA_512
Andrzej Kureke02da812022-08-17 17:04:49 -04001500 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001501 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
1502 * psa_crypto_init() before doing any TLS operations.
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001503 *
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001504 * Comment this macro to disable support for TLS 1.2 / DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001505 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001506#define MBEDTLS_SSL_PROTO_TLS1_2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001507
1508/**
Ronald Cron6f135e12021-12-08 16:57:54 +01001509 * \def MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001510 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001511 * Enable support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001512 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001513 * \note The support for TLS 1.3 is not comprehensive yet, in particular
1514 * pre-shared keys are not supported.
1515 * See docs/architecture/tls13-support.md for a description of the TLS
1516 * 1.3 support that this option enables.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001517 *
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001518 * Requires: MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Manuel Pégourié-Gonnard3e830982022-05-11 13:27:44 +02001519 * Requires: MBEDTLS_PSA_CRYPTO_C
1520 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02001521 * Note: even though TLS 1.3 depends on PSA Crypto, and uses it unconditonally
1522 * for most operations, if you want it to only use PSA for all crypto
1523 * operations, you need to also enable MBEDTLS_USE_PSA_CRYPTO; otherwise X.509
1524 * operations, and functions that are common with TLS 1.2 (record protection,
1525 * running handshake hash) will still use non-PSA crypto.
Tom Cosgroveafb2fe12022-06-29 16:36:12 +01001526 *
Ronald Cron6f135e12021-12-08 16:57:54 +01001527 * Uncomment this macro to enable the support for TLS 1.3.
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001528 */
Ronald Cron6f135e12021-12-08 16:57:54 +01001529//#define MBEDTLS_SSL_PROTO_TLS1_3
Hanno Becker9fc15ea2020-05-04 12:00:47 +01001530
1531/**
Ronald Cronab65c522021-11-24 10:47:20 +01001532 * \def MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1533 *
1534 * Enable TLS 1.3 middlebox compatibility mode.
1535 *
1536 * As specified in Section D.4 of RFC 8446, TLS 1.3 offers a compatibility
1537 * mode to make a TLS 1.3 connection more likely to pass through middle boxes
1538 * expecting TLS 1.2 traffic.
1539 *
1540 * Turning on the compatibility mode comes at the cost of a few added bytes
1541 * on the wire, but it doesn't affect compatibility with TLS 1.3 implementations
1542 * that don't use it. Therefore, unless transmission bandwidth is critical and
1543 * you know that middlebox compatibility issues won't occur, it is therefore
1544 * recommended to set this option.
1545 *
1546 * Comment to disable compatibility mode for TLS 1.3. If
Ronald Cron6f135e12021-12-08 16:57:54 +01001547 * MBEDTLS_SSL_PROTO_TLS1_3 is not enabled, this option does not have any
1548 * effect on the build.
Ronald Cronab65c522021-11-24 10:47:20 +01001549 *
1550 */
1551//#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
1552
1553/**
Jerry Yu9750f812022-07-20 11:04:50 +08001554 * \def MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH
Jerry Yu0038c5f2022-07-07 06:49:01 +00001555 *
1556 * Size in bytes of a ticket nonce. This is not used in TLS 1.2.
1557 *
Jerry Yu08aed4d2022-07-20 10:36:12 +08001558 * This must be less than 256.
Jerry Yu0038c5f2022-07-07 06:49:01 +00001559 */
Jerry Yu9750f812022-07-20 11:04:50 +08001560#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Jerry Yu0038c5f2022-07-07 06:49:01 +00001561
1562/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563 * \def MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001564 *
1565 * Enable support for DTLS (all available versions).
1566 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001567 * Enable this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001568 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02001569 * Requires: MBEDTLS_SSL_PROTO_TLS1_2
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001570 *
1571 * Comment this macro to disable support for DTLS
1572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#define MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001574
1575/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001576 * \def MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001577 *
Manuel Pégourié-Gonnard6b298e62014-11-20 18:28:50 +01001578 * Enable support for RFC 7301 Application Layer Protocol Negotiation.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001579 *
Paul Bakker27e36d32014-04-08 12:33:37 +02001580 * Comment this macro to disable support for ALPN.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001581 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582#define MBEDTLS_SSL_ALPN
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001583
1584/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585 * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001586 *
1587 * Enable support for the anti-replay mechanism in DTLS.
1588 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589 * Requires: MBEDTLS_SSL_TLS_C
1590 * MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001591 *
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001592 * \warning Disabling this is often a security risk!
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001593 * See mbedtls_ssl_conf_dtls_anti_replay() for details.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001594 *
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001595 * Comment this to disable anti-replay in DTLS.
1596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
Manuel Pégourié-Gonnard8464a462014-09-24 14:05:32 +02001598
1599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001601 *
1602 * Enable support for HelloVerifyRequest on DTLS servers.
1603 *
1604 * This feature is highly recommended to prevent DTLS servers being used as
1605 * amplifiers in DoS attacks against other hosts. It should always be enabled
1606 * unless you know for sure amplification cannot be a problem in the
1607 * environment in which your server operates.
1608 *
Andrzej Kurek5c65c572022-04-13 14:28:52 -04001609 * \warning Disabling this can be a security risk! (see above)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001610 *
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001611 * Requires: MBEDTLS_SSL_PROTO_DTLS
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001612 *
1613 * Comment this to disable support for HelloVerifyRequest.
1614 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001615#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard82202f02014-07-23 00:28:58 +02001616
1617/**
Johan Pascalb62bb512015-12-03 21:56:45 +01001618 * \def MBEDTLS_SSL_DTLS_SRTP
1619 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02001620 * Enable support for negotiation of DTLS-SRTP (RFC 5764)
Johan Pascal842d6712020-09-23 13:34:40 +02001621 * through the use_srtp extension.
1622 *
1623 * \note This feature provides the minimum functionality required
1624 * to negotiate the use of DTLS-SRTP and to allow the derivation of
1625 * the associated SRTP packet protection key material.
1626 * In particular, the SRTP packet protection itself, as well as the
1627 * demultiplexing of RTP and DTLS packets at the datagram layer
1628 * (see Section 5 of RFC 5764), are not handled by this feature.
1629 * Instead, after successful completion of a handshake negotiating
1630 * the use of DTLS-SRTP, the extended key exporter API
Hanno Becker2d6e6f82021-05-24 10:58:31 +01001631 * mbedtls_ssl_conf_export_keys_cb() should be used to implement
Johan Pascal842d6712020-09-23 13:34:40 +02001632 * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705
1633 * (this is implemented in the SSL example programs).
1634 * The resulting key should then be passed to an SRTP stack.
1635 *
1636 * Setting this option enables the runtime API
1637 * mbedtls_ssl_conf_dtls_srtp_protection_profiles()
1638 * through which the supported DTLS-SRTP protection
1639 * profiles can be configured. You must call this API at
1640 * runtime if you wish to negotiate the use of DTLS-SRTP.
Johan Pascalb62bb512015-12-03 21:56:45 +01001641 *
1642 * Requires: MBEDTLS_SSL_PROTO_DTLS
1643 *
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001644 * Uncomment this to enable support for use_srtp extension.
Johan Pascalb62bb512015-12-03 21:56:45 +01001645 */
Ron Eldor9cfb5eb2018-12-10 15:30:14 +02001646//#define MBEDTLS_SSL_DTLS_SRTP
Johan Pascalb62bb512015-12-03 21:56:45 +01001647
1648/**
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001649 * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1650 *
1651 * Enable server-side support for clients that reconnect from the same port.
1652 *
1653 * Some clients unexpectedly close the connection and try to reconnect using the
1654 * same source port. This needs special support from the server to handle the
Simon Butcher4f6882a2015-09-11 17:12:46 +01001655 * new connection securely, as described in section 4.2.8 of RFC 6347. This
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001656 * flag enables that support.
1657 *
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001658 * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY
Manuel Pégourié-Gonnard62c74bb2015-09-08 17:50:29 +02001659 *
Manuel Pégourié-Gonnard26d227d2015-09-04 10:53:25 +02001660 * Comment this to disable support for clients reusing the source port.
1661 */
1662#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
1663
1664/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665 * \def MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001666 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001667 * Enable support for RFC 5077 session tickets in SSL.
Antonin Décimo36e89b52019-01-23 15:24:37 +01001668 * Client-side, provides full support for session tickets (maintenance of a
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02001669 * session store remains the responsibility of the application, though).
1670 * Server-side, you also need to provide callbacks for writing and parsing
1671 * tickets, including authenticated encryption and key management. Example
1672 * callbacks are provided by MBEDTLS_SSL_TICKET_C.
Paul Bakkera503a632013-08-14 13:48:06 +02001673 *
1674 * Comment this macro to disable support for SSL session tickets
1675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001676#define MBEDTLS_SSL_SESSION_TICKETS
Paul Bakkera503a632013-08-14 13:48:06 +02001677
1678/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001679 * \def MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001680 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001681 * Enable support for RFC 6066 server name indication (SNI) in SSL.
Paul Bakker0be444a2013-08-27 21:55:01 +02001682 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001683 * Requires: MBEDTLS_X509_CRT_PARSE_C
Manuel Pégourié-Gonnardbbbb3cf2015-01-28 16:44:37 +00001684 *
Paul Bakker0be444a2013-08-27 21:55:01 +02001685 * Comment this macro to disable support for server name indication in SSL
1686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001687#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Paul Bakker0be444a2013-08-27 21:55:01 +02001688
1689/**
Gilles Peskinef03bd812020-03-23 18:13:58 +01001690 * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1691 *
Andrzej Kurek2a54a6f2021-01-07 08:13:49 -05001692 * When this option is enabled, the SSL buffer will be resized automatically
1693 * based on the negotiated maximum fragment length in each direction.
Andrzej Kurek557289b2020-10-21 15:12:39 +02001694 *
1695 * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Gilles Peskinef03bd812020-03-23 18:13:58 +01001696 */
1697//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
1698
1699/**
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001700 * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1701 *
1702 * Enable testing of the constant-flow nature of some sensitive functions with
1703 * clang's MemorySanitizer. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001704 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001705 *
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001706 * This setting requires compiling with clang -fsanitize=memory. The test
1707 * suites can then be run normally.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001708 *
Manuel Pégourié-Gonnard8ff863b2020-07-31 12:59:34 +02001709 * \warning This macro is only used for extended testing; it is not considered
1710 * part of the library's API, so it may change or disappear at any time.
1711 *
Manuel Pégourié-Gonnard390fb4f2020-07-24 11:08:40 +02001712 * Uncomment to enable testing of the constant-flow nature of selected code.
Manuel Pégourié-Gonnard6240def2020-07-10 09:35:54 +02001713 */
1714//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
1715
1716/**
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001717 * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1718 *
1719 * Enable testing of the constant-flow nature of some sensitive functions with
1720 * valgrind's memcheck tool. This causes some existing tests to also test
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001721 * this non-functional property of the code under test.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001722 *
1723 * This setting requires valgrind headers for building, and is only useful for
Manuel Pégourié-Gonnarddd00bfc2020-08-24 12:58:36 +02001724 * testing if the tests suites are run with valgrind's memcheck. This can be
1725 * done for an individual test suite with 'valgrind ./test_suite_xxx', or when
1726 * using CMake, this can be done for all test suites with 'make memcheck'.
Manuel Pégourié-Gonnard73afa372020-08-19 10:27:38 +02001727 *
1728 * \warning This macro is only used for extended testing; it is not considered
1729 * part of the library's API, so it may change or disappear at any time.
1730 *
1731 * Uncomment to enable testing of the constant-flow nature of selected code.
1732 */
1733//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
1734
1735/**
Gilles Peskinefea6eaf2019-09-11 13:27:48 +02001736 * \def MBEDTLS_TEST_HOOKS
1737 *
1738 * Enable features for invasive testing such as introspection functions and
1739 * hooks for fault injection. This enables additional unit tests.
1740 *
1741 * Merely enabling this feature should not change the behavior of the product.
1742 * It only adds new code, and new branching points where the default behavior
1743 * is the same as when this feature is disabled.
1744 * However, this feature increases the attack surface: there is an added
1745 * risk of vulnerabilities, and more gadgets that can make exploits easier.
1746 * Therefore this feature must never be enabled in production.
1747 *
1748 * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more
1749 * information.
1750 *
1751 * Uncomment to enable invasive tests.
1752 */
1753//#define MBEDTLS_TEST_HOOKS
1754
1755/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001756 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001757 *
1758 * Provide your own alternate threading implementation.
1759 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001760 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001761 *
1762 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001765
1766/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001768 *
1769 * Enable the pthread wrapper layer for the threading layer.
1770 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001771 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001772 *
1773 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001774 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001776
1777/**
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001778 * \def MBEDTLS_USE_PSA_CRYPTO
1779 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001780 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1781 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001782 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001783 * \note Development of this option is currently in progress, and parts of Mbed
1784 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001785 * will still continue to work as usual, so enabling this option should not
1786 * break backwards compatibility.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001787 *
Manuel Pégourié-Gonnard13b0beb2021-09-20 13:21:25 +02001788 * \note See docs/use-psa-crypto.md for a complete description of what this
1789 * option currently does, and of parts that are not affected by it so far.
1790 *
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001791 * \warning If you enable this option, you need to call `psa_crypto_init()`
1792 * before calling any function from the SSL/TLS, X.509 or PK modules.
Hanno Becker51560b62018-11-19 09:46:26 +00001793 *
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001794 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnardff43ff62022-04-20 15:32:01 +02001795 * Conflicts with: MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001796 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001797 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnardaeefa492018-10-22 12:14:52 +02001798 */
1799//#define MBEDTLS_USE_PSA_CRYPTO
1800
1801/**
John Durkop6e33dbe2020-09-17 21:15:13 -07001802 * \def MBEDTLS_PSA_CRYPTO_CONFIG
1803 *
John Durkop185764f2020-10-12 21:32:12 -07001804 * This setting allows support for cryptographic mechanisms through the PSA
1805 * API to be configured separately from support through the mbedtls API.
John Durkop6e33dbe2020-09-17 21:15:13 -07001806 *
Gilles Peskinedb0421b2022-04-13 23:22:49 +02001807 * When this option is disabled, the PSA API exposes the cryptographic
1808 * mechanisms that can be implemented on top of the `mbedtls_xxx` API
1809 * configured with `MBEDTLS_XXX` symbols.
Gilles Peskine750596e2022-03-16 17:03:55 +01001810 *
1811 * When this option is enabled, the PSA API exposes the cryptographic
1812 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in
1813 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are
1814 * automatically enabled if required (i.e. if no PSA driver provides the
1815 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols
1816 * in mbedtls_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001817 *
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01001818 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies
Gilles Peskine0c4db1f2022-04-14 12:44:01 +02001819 * an alternative header to include instead of include/psa/crypto_config.h.
Gilles Peskine58858b72020-11-09 15:26:09 +01001820 *
John Durkop185764f2020-10-12 21:32:12 -07001821 * This feature is still experimental and is not ready for production since
1822 * it is not completed.
John Durkop6e33dbe2020-09-17 21:15:13 -07001823 */
1824//#define MBEDTLS_PSA_CRYPTO_CONFIG
1825
1826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001828 *
1829 * Allow run-time checking of compile-time enabled features. Thus allowing users
1830 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001832 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001833 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001834 *
1835 * Comment this to disable run-time checking and save ROM space
1836 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001837#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001838
1839/**
Hanno Becker288dedc2019-03-27 11:00:53 +00001840 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1841 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001842 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
Hanno Becker288dedc2019-03-27 11:00:53 +00001843 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1844 * the set of trusted certificates through a callback instead of a linked
1845 * list.
1846 *
1847 * This is useful for example in environments where a large number of trusted
1848 * certificates is present and storing them in a linked list isn't efficient
1849 * enough, or when the set of trusted certificates changes frequently.
1850 *
Jarno Lamsaf49fedc2019-04-01 14:58:30 +03001851 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
Hanno Becker288dedc2019-03-27 11:00:53 +00001852 * `mbedtls_ssl_conf_ca_cb()` for more information.
1853 *
1854 * Uncomment to enable trusted certificate callbacks.
1855 */
1856//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1857
1858/**
Hanno Becker612a2f12020-10-09 09:19:39 +01001859 * \def MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001860 *
Chris Jones2c745862020-12-16 11:41:06 +00001861 * Disable mbedtls_x509_*_info() and related APIs.
Peter Kolbus9a969b62018-12-11 13:55:56 -06001862 *
Chris Jones2c745862020-12-16 11:41:06 +00001863 * Uncomment to omit mbedtls_x509_*_info(), as well as mbedtls_debug_print_crt()
Peter Kolbus9a969b62018-12-11 13:55:56 -06001864 * and other functions/constants only used by these functions, thus reducing
1865 * the code footprint by several KB.
1866 */
Chris Jones2c745862020-12-16 11:41:06 +00001867//#define MBEDTLS_X509_REMOVE_INFO
Peter Kolbus9a969b62018-12-11 13:55:56 -06001868
1869/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardd1539b12014-06-06 16:42:37 +02001871 *
1872 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1873 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1874 *
1875 * Comment this macro to disallow using RSASSA-PSS in certificates.
1876 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01001878/** \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001879
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001880/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001881 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001882 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001883 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001884 * \{
1885 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001886
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001887/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001888 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001889 *
1890 * Enable AES-NI support on x86-64.
1891 *
1892 * Module: library/aesni.c
1893 * Caller: library/aes.c
1894 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001895 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001896 *
1897 * This modules adds support for the AES-NI instructions on x86-64
1898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001900
1901/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001903 *
1904 * Enable the AES block cipher.
1905 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001906 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001907 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001908 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001909 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001910 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00001911 * This module enables the following ciphersuites (if other requisites are
1912 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001913 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1914 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1915 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1916 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1917 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1918 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1919 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1920 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1921 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1922 * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1923 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1924 * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1925 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1926 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1927 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1928 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1929 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1930 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1931 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1932 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1933 * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1934 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1935 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1936 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1937 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1938 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1939 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1940 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1941 * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1942 * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1943 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1944 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1945 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1946 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1947 * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1948 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1949 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1950 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1951 * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1952 * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1953 * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384
1954 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256
1955 * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA
1956 * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256
1957 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256
1958 * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA
1959 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1960 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1961 * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1962 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1963 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1964 * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1965 * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384
1966 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384
1967 * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA
1968 * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256
1969 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256
1970 * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01001971 *
Paul Bakkercff68422013-09-15 20:43:33 +02001972 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00001973 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001975
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001976/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001978 *
1979 * Enable the generic ASN1 parser.
1980 *
1981 * Module: library/asn1.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001982 * Caller: library/x509.c
1983 * library/dhm.c
1984 * library/pkcs12.c
1985 * library/pkcs5.c
1986 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00001987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001989
1990/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001992 *
1993 * Enable the generic ASN1 writer.
1994 *
1995 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001996 * Caller: library/ecdsa.c
1997 * library/pkwrite.c
1998 * library/x509_create.c
1999 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002000 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00002003
2004/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002006 *
2007 * Enable the Base64 module.
2008 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002009 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00002010 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002011 *
Paul Bakker5690efc2011-05-26 13:16:06 +00002012 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00002013 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002014#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002015
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002016/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002017 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002018 *
Paul Bakker9a736322012-11-14 12:39:52 +00002019 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002020 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002021 * Module: library/bignum.c
Janos Follath3ca07752022-08-09 11:45:47 +01002022 * library/bignum_core.c
Janos Follathd1baedb2022-08-09 13:44:53 +01002023 * library/bignum_mod.c
Gabor Mezeid41f6272022-08-12 15:20:21 +02002024 * library/bignum_mod_raw.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002025 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002026 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002027 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002028 * library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002029 * library/rsa_alt_helpers.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002030 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002031 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02002032 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00002033 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002035
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002036/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002038 *
2039 * Enable the Camellia block cipher.
2040 *
Paul Bakker38119b12009-01-10 23:31:23 +00002041 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002042 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00002043 *
Paul Bakker645ce3a2012-10-31 12:32:41 +00002044 * This module enables the following ciphersuites (if other requisites are
2045 * enabled as well):
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2047 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2048 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
2049 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
2050 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2051 * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2052 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
2053 * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
2054 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
2055 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2056 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
2057 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
2058 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
2059 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
2060 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
2061 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
2062 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2063 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
2064 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
2065 * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2066 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
2067 * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
2068 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
2069 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2070 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
2071 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
2072 * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2073 * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
2074 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
2075 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
2076 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
2077 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
2078 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
2079 * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
2080 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
2081 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
2082 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
2083 * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
2084 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
2085 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
2086 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
2087 * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00002088 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00002090
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002091/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002092 * \def MBEDTLS_ARIA_C
2093 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002094 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002095 *
2096 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01002097 * Caller: library/cipher.c
2098 *
2099 * This module enables the following ciphersuites (if other requisites are
2100 * enabled as well):
2101 *
2102 * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256
2103 * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384
2104 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
2105 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
2106 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
2107 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
2108 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
2109 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
2110 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
2111 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
2112 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
2113 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
2114 * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256
2115 * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384
2116 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
2117 * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
2118 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
2119 * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
2120 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
2121 * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
2122 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
2123 * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
2124 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
2125 * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
2126 * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256
2127 * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384
2128 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
2129 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
2130 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
2131 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
2132 * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256
2133 * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384
2134 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
2135 * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
2136 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
2137 * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
2138 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
2139 * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002140 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002141#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00002142
2143/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002144 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002145 *
2146 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
2147 *
2148 * Module: library/ccm.c
2149 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002150 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2151 * MBEDTLS_ARIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002152 *
2153 * This module enables the AES-CCM ciphersuites, if other requisites are
2154 * enabled as well.
2155 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02002157
2158/**
Daniel King34b822c2016-05-15 17:28:08 -03002159 * \def MBEDTLS_CHACHA20_C
2160 *
2161 * Enable the ChaCha20 stream cipher.
2162 *
2163 * Module: library/chacha20.c
2164 */
2165#define MBEDTLS_CHACHA20_C
2166
2167/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02002168 * \def MBEDTLS_CHACHAPOLY_C
2169 *
2170 * Enable the ChaCha20-Poly1305 AEAD algorithm.
2171 *
2172 * Module: library/chachapoly.c
2173 *
2174 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
2175 */
2176#define MBEDTLS_CHACHAPOLY_C
2177
2178/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002180 *
2181 * Enable the generic cipher layer.
2182 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00002183 * Module: library/cipher.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002184 * Caller: library/ccm.c
2185 * library/cmac.c
2186 * library/gcm.c
2187 * library/nist_kw.c
Przemek Stekielea805b42022-05-02 10:30:03 +02002188 * library/pkcs12.c
2189 * library/pkcs5.c
2190 * library/psa_crypto_aead.c
2191 * library/psa_crypto_mac.c
2192 * library/ssl_ciphersuites.c
2193 * library/ssl_msg.c
Przemek Stekiela09f8352022-05-12 09:34:28 +02002194 * library/ssl_ticket.c (unless MBEDTLS_USE_PSA_CRYPTO is enabled)
Paul Bakker8123e9d2011-01-06 15:37:30 +00002195 *
2196 * Uncomment to enable generic cipher wrappers.
2197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00002199
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002200/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002201 * \def MBEDTLS_CMAC_C
2202 *
Simon Butcher327398a2016-10-05 14:09:11 +01002203 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
2204 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002205 *
Steven Cooremanc338cef2021-04-26 11:24:44 +02002206 * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying
2207 * implementation of the CMAC algorithm is provided by an alternate
2208 * implementation, that alternate implementation may opt to not support
2209 * AES-192 or 3DES as underlying block ciphers for the CMAC operation.
2210 *
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002211 * Module: library/cmac.c
2212 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002213 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002214 *
2215 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002216#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00002217
2218/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002219 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002220 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03002221 * Enable the CTR_DRBG AES-based random generator.
2222 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02002223 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002224 *
Gilles Peskine7e279362019-10-03 14:21:39 +02002225 * \note To achieve a 256-bit security strength with CTR_DRBG,
2226 * you must use AES-256 *and* use sufficient entropy.
2227 * See ctr_drbg.h for more details.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002228 *
2229 * Module: library/ctr_drbg.c
2230 * Caller:
2231 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002233 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03002234 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002235 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00002237
2238/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 * \def MBEDTLS_DEBUG_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002240 *
2241 * Enable the debug functions.
2242 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002243 * Module: library/debug.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002244 * Caller: library/ssl_msg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002245 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002246 * library/ssl_tls12_*.c
2247 * library/ssl_tls13_*.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002248 *
2249 * This module provides debugging functions.
2250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002251#define MBEDTLS_DEBUG_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002252
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002253/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002254 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002255 *
2256 * Enable the DES block cipher.
2257 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002258 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002259 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01002260 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002261 *
Paul Bakkercff68422013-09-15 20:43:33 +02002262 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002263 *
2264 * \warning DES is considered a weak cipher and its use constitutes a
2265 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00002266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002268
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002269/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002271 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002272 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002273 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002274 * Module: library/dhm.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002275 * Caller: library/ssl_tls.c
2276 * library/ssl*_client.c
2277 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002278 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002279 * This module is used by the following key exchanges:
2280 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01002281 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01002282 * \warning Using DHE constitutes a security risk as it
2283 * is not possible to validate custom DH parameters.
2284 * If possible, it is recommended users should consider
2285 * preferring other methods of key exchange.
2286 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01002287 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002289#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002290
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002291/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002292 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002293 *
2294 * Enable the elliptic curve Diffie-Hellman library.
2295 *
2296 * Module: library/ecdh.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002297 * Caller: library/psa_crypto.c
2298 * library/ssl_tls.c
2299 * library/ssl*_client.c
2300 * library/ssl*_server.c
Paul Bakker41c83d32013-03-20 14:39:14 +01002301 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002302 * This module is used by the following key exchanges:
2303 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002304 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002305 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002307#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002308
2309/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002310 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002311 *
2312 * Enable the elliptic curve DSA library.
2313 *
2314 * Module: library/ecdsa.c
2315 * Caller:
2316 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002317 * This module is used by the following key exchanges:
2318 * ECDHE-ECDSA
2319 *
Gilles Peskine799e5762018-09-14 17:34:00 +02002320 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C,
2321 * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a
2322 * short Weierstrass curve.
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002324#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002325
2326/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002327 * \def MBEDTLS_ECJPAKE_C
2328 *
2329 * Enable the elliptic curve J-PAKE library.
2330 *
Tomasz Rodziewicz532ca932021-05-07 11:01:24 +02002331 * \note EC J-PAKE support is based on the Thread v1.0.0 specification.
2332 * It has not been reviewed for compliance with newer standards such as
Tomasz Rodziewicz1fc7c4c2021-05-07 10:13:31 +02002333 * Thread v1.1 or RFC 8236.
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02002334 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002335 * Module: library/ecjpake.c
2336 * Caller:
2337 *
2338 * This module is used by the following key exchanges:
2339 * ECJPAKE
2340 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002341 * Requires: MBEDTLS_ECP_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C
Neil Armstrongecaba1c2022-08-11 10:47:08 +02002342 *
2343 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2344 * before doing any EC J-PAKE operations.
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002345 */
Tomasz Rodziewiczb1336052021-04-22 15:14:17 +02002346#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002347
2348/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002349 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002350 *
2351 * Enable the elliptic curve over GF(p) library.
2352 *
2353 * Module: library/ecp.c
2354 * Caller: library/ecdh.c
2355 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02002356 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01002361
2362/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002363 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002364 *
2365 * Enable the platform-specific entropy code.
2366 *
2367 * Module: library/entropy.c
2368 * Caller:
2369 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002371 *
2372 * This module provides a generic entropy pool
2373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002374#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00002375
2376/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002378 *
2379 * Enable error code to error string conversion.
2380 *
2381 * Module: library/error.c
2382 * Caller:
2383 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002384 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00002385 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00002387
2388/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002390 *
Jaeden Amero7accf442019-04-10 18:13:57 +01002391 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00002392 *
2393 * Module: library/gcm.c
2394 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002395 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or
2396 * MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00002397 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002398 * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other
2399 * requisites are enabled as well.
Paul Bakker89e80c92012-03-20 13:50:09 +00002400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002401#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00002402
2403/**
Thomas Fossati656864b2016-07-17 08:51:22 +01002404 * \def MBEDTLS_HKDF_C
2405 *
2406 * Enable the HKDF algorithm (RFC 5869).
2407 *
2408 * Module: library/hkdf.c
2409 * Caller:
2410 *
2411 * Requires: MBEDTLS_MD_C
2412 *
2413 * This module adds support for the Hashed Message Authentication Code
2414 * (HMAC)-based key derivation function (HKDF).
2415 */
2416#define MBEDTLS_HKDF_C
2417
2418/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002420 *
2421 * Enable the HMAC_DRBG random generator.
2422 *
2423 * Module: library/hmac_drbg.c
2424 * Caller:
2425 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002427 *
Tom Cosgrove1e211442022-05-26 11:51:00 +01002428 * Uncomment to enable the HMAC_DRBG random number generator.
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002429 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01002431
2432/**
Ron Eldor466a57f2018-05-03 16:54:28 +03002433 * \def MBEDTLS_NIST_KW_C
2434 *
2435 * Enable the Key Wrapping mode for 128-bit block ciphers,
2436 * as defined in NIST SP 800-38F. Only KW and KWP modes
2437 * are supported. At the moment, only AES is approved by NIST.
2438 *
2439 * Module: library/nist_kw.c
2440 *
2441 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
2442 */
TRodziewicz85aff9f2021-04-23 10:47:26 +02002443#define MBEDTLS_NIST_KW_C
Ron Eldor466a57f2018-05-03 16:54:28 +03002444
2445/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002446 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002447 *
2448 * Enable the generic message digest layer.
2449 *
Manuel Pégourié-Gonnard1f7f7172022-07-18 12:04:05 +02002450 * Requires: one of: MBEDTLS_MD5_C, MBEDTLS_RIPEMD160_C, MBEDTLS_SHA1_C,
2451 * MBEDTLS_SHA224_C, MBEDTLS_SHA256_C, MBEDTLS_SHA384_C,
2452 * MBEDTLS_SHA512_C.
Simon Butcher2cb47392016-11-04 12:23:11 +00002453 * Module: library/md.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002454 * Caller: library/constant_time.c
2455 * library/ecdsa.c
2456 * library/ecjpake.c
2457 * library/hkdf.c
2458 * library/hmac_drbg.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002459 * library/pk.c
2460 * library/pkcs5.c
2461 * library/pkcs12.c
2462 * library/psa_crypto_ecp.c
2463 * library/psa_crypto_rsa.c
2464 * library/rsa.c
2465 * library/ssl_cookie.c
2466 * library/ssl_msg.c
2467 * library/ssl_tls.c
Przemek Stekiel6e712822022-05-06 11:40:20 +02002468 * library/x509.c
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002469 * library/x509_crt.c
2470 * library/x509write_crt.c
2471 * library/x509write_csr.c
Paul Bakker17373852011-01-06 14:20:01 +00002472 *
2473 * Uncomment to enable generic message digest wrappers.
2474 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002475#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00002476
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002477/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002479 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002480 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002481 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002482 * Module: library/md5.c
2483 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002484 * library/pem.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01002485 * library/ssl_tls.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002486 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002487 * This module is required for TLS 1.2 depending on the handshake parameters.
2488 * Further, it is used for checking MD5-signed certificates, and for PBKDF1
2489 * when decrypting PEM-encoded encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002490 *
2491 * \warning MD5 is considered a weak message digest and its use constitutes a
2492 * security risk. If possible, we recommend avoiding dependencies on
2493 * it, and considering stronger message digests instead.
2494 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002497
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002499 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002500 *
2501 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002502 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002503 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02002504 *
2505 * Module: library/memory_buffer_alloc.c
2506 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002507 * Requires: MBEDTLS_PLATFORM_C
2508 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02002509 *
2510 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02002511 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002512//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02002513
2514/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 * \def MBEDTLS_NET_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002516 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002517 * Enable the TCP and UDP over IPv6/IPv4 networking routines.
2518 *
Simon Butcherd567a232016-03-09 20:19:21 +00002519 * \note This module only works on POSIX/Unix (including Linux, BSD and OS X)
2520 * and Windows. For other platforms, you'll want to disable it, and write your
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002521 * own networking callbacks to be passed to \c mbedtls_ssl_set_bio().
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002522 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002523 * \note See also our Knowledge Base article about porting to a new
2524 * environment:
2525 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2526 *
Andres AG788aa4a2016-09-14 14:32:09 +01002527 * Module: library/net_sockets.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002528 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01002529 * This module provides networking routines.
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531#define MBEDTLS_NET_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002532
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002533/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002534 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002535 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002536 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02002537 *
2538 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002539 * Caller: library/asn1write.c
2540 * library/pkcs5.c
2541 * library/pkparse.c
2542 * library/pkwrite.c
2543 * library/rsa.c
2544 * library/x509.c
2545 * library/x509_create.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002546 * library/x509_crl.c
2547 * library/x509_crt.c
2548 * library/x509_csr.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002549 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002550 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02002551 *
2552 * This modules translates between OIDs and internal values.
2553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02002555
2556/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002557 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002558 *
2559 * Enable VIA Padlock support on x86.
2560 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002561 * Module: library/padlock.c
2562 * Caller: library/aes.c
2563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002564 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002565 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002566 * This modules adds support for the VIA PadLock on x86.
2567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002568#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002569
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002571 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002572 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002573 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00002574 *
2575 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002576 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02002577 * library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002578 * library/x509_crl.c
2579 * library/x509_crt.c
2580 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00002581 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00002583 *
Paul Bakkercff68422013-09-15 20:43:33 +02002584 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00002585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002587
2588/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02002590 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002591 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02002592 *
2593 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002594 * Caller: library/pkwrite.c
2595 * library/x509write_crt.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002596 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02002597 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002598 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02002599 *
2600 * This modules adds support for encoding / writing PEM files.
2601 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002602#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00002603
2604/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002606 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002607 * Enable the generic public (asymmetric) key layer.
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002608 *
2609 * Module: library/pk.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002610 * Caller: library/psa_crypto_rsa.c
2611 * library/ssl_tls.c
2612 * library/ssl*_client.c
2613 * library/ssl*_server.c
2614 * library/x509.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002615 *
Przemek Stekiel6aadf0b2022-04-27 14:46:52 +02002616 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02002617 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002618 * Uncomment to enable generic public key wrappers.
2619 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02002621
2622/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002623 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002624 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002625 * Enable the generic public (asymmetric) key parser.
Paul Bakker4606c732013-09-15 17:04:23 +02002626 *
2627 * Module: library/pkparse.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002628 * Caller: library/x509_crt.c
2629 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02002630 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002632 *
2633 * Uncomment to enable generic public key parse functions.
2634 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002635#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002636
2637/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002638 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002639 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002640 * Enable the generic public (asymmetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02002641 *
2642 * Module: library/pkwrite.c
2643 * Caller: library/x509write.c
2644 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02002646 *
2647 * Uncomment to enable generic public key write functions.
2648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02002650
2651/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002653 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002654 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002655 *
2656 * Module: library/pkcs5.c
2657 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02002658 * Requires: MBEDTLS_CIPHER_C and either MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2659 *
2660 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2661 * before doing any PKCS5 operation.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002662 *
2663 * This module adds support for the PKCS#5 functions.
2664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002665#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002666
2667/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002668 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002669 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002670 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002671 * Adds algorithms for parsing PKCS#8 encrypted private keys
2672 *
2673 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002674 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002675 *
Andrzej Kurek7bd12c52022-08-24 10:47:10 -04002676 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C and either
2677 * MBEDTLS_MD_C or MBEDTLS_PSA_CRYPTO_C.
2678 *
2679 * \warning If building without MBEDTLS_MD_C, you must call psa_crypto_init()
2680 * before doing any PKCS12 operation.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002681 *
2682 * This module enables PKCS#12 functions.
2683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002684#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002685
2686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002688 *
2689 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002690 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002691 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2693 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002694 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002695 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002696 * \note This abstraction layer must be enabled on Windows (including MSYS2)
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02002697 * as other modules rely on it for a fixed snprintf implementation.
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002698 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002699 * Module: library/platform.c
2700 * Caller: Most other .c files
2701 *
2702 * This module enables abstraction of common (libc) functions.
2703 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002704#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002705
2706/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002707 * \def MBEDTLS_POLY1305_C
2708 *
2709 * Enable the Poly1305 MAC algorithm.
2710 *
2711 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002712 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002713 */
2714#define MBEDTLS_POLY1305_C
2715
2716/**
Jaeden Amero484ee332018-10-25 17:38:05 +01002717 * \def MBEDTLS_PSA_CRYPTO_C
2718 *
2719 * Enable the Platform Security Architecture cryptography API.
2720 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002721 * Module: library/psa_crypto.c
Jaeden Amero484ee332018-10-25 17:38:05 +01002722 *
Przemek Stekielea805b42022-05-02 10:30:03 +02002723 * Requires: MBEDTLS_CIPHER_C,
2724 * either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskine82e57d12020-11-13 21:31:17 +01002725 * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C,
Gilles Peskinef08b3f82020-11-13 17:36:48 +01002726 * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG.
Jaeden Amero484ee332018-10-25 17:38:05 +01002727 *
2728 */
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002729#define MBEDTLS_PSA_CRYPTO_C
Jaeden Amero484ee332018-10-25 17:38:05 +01002730
2731/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002732 * \def MBEDTLS_PSA_CRYPTO_SE_C
2733 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002734 * Enable dynamic secure element support in the Platform Security Architecture
Gilles Peskinea8ade162019-06-26 11:24:49 +02002735 * cryptography API.
2736 *
Gilles Peskine98473c42022-06-20 18:46:22 +02002737 * \deprecated This feature is deprecated. Please switch to the driver
2738 * interface enabled by #MBEDTLS_PSA_CRYPTO_DRIVERS.
Gilles Peskined0e66b02019-07-24 13:52:51 +02002739 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002740 * Module: library/psa_crypto_se.c
2741 *
2742 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2743 *
2744 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002745//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002746
2747/**
Andrzej Kurekc6905232019-02-05 05:23:41 -05002748 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2749 *
2750 * Enable the Platform Security Architecture persistent key storage.
2751 *
Darryl Greendb2b8db2018-06-15 13:06:04 +01002752 * Module: library/psa_crypto_storage.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002753 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002754 * Requires: MBEDTLS_PSA_CRYPTO_C,
2755 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2756 * the PSA ITS interface
Andrzej Kurekc6905232019-02-05 05:23:41 -05002757 */
Darryl Greendb2b8db2018-06-15 13:06:04 +01002758#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002759
2760/**
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002761 * \def MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002762 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002763 * Enable the emulation of the Platform Security Architecture
2764 * Internal Trusted Storage (PSA ITS) over files.
Andrzej Kurekc6905232019-02-05 05:23:41 -05002765 *
Gilles Peskine6194dc22018-11-16 22:24:15 +01002766 * Module: library/psa_its_file.c
Andrzej Kurekc6905232019-02-05 05:23:41 -05002767 *
Jaeden Amero57f4d9e2019-03-15 16:14:19 +00002768 * Requires: MBEDTLS_FS_IO
Andrzej Kurekc6905232019-02-05 05:23:41 -05002769 */
Gilles Peskine6194dc22018-11-16 22:24:15 +01002770#define MBEDTLS_PSA_ITS_FILE_C
Andrzej Kurekc6905232019-02-05 05:23:41 -05002771
2772/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002773 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002774 *
2775 * Enable the RIPEMD-160 hash algorithm.
2776 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002777 * Module: library/ripemd160.c
2778 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002779 *
2780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002782
2783/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002784 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002785 *
2786 * Enable the RSA public-key cryptosystem.
2787 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002788 * Module: library/rsa.c
Chris Jones3848e312021-03-11 16:17:59 +00002789 * library/rsa_alt_helpers.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002790 * Caller: library/pk.c
2791 * library/psa_crypto.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002792 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002793 * library/ssl*_client.c
2794 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002795 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002796 * This module is used by the following key exchanges:
2797 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002798 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002799 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002800 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002801#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002802
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002803/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002805 *
2806 * Enable the SHA1 cryptographic hash algorithm.
2807 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002808 * Module: library/sha1.c
2809 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002810 * library/psa_crypto_hash.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002811 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02002812 * This module is required for TLS 1.2 depending on the handshake parameters,
2813 * and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002814 *
2815 * \warning SHA-1 is considered a weak message digest and its use constitutes
2816 * a security risk. If possible, we recommend avoiding dependencies
2817 * on it, and considering stronger message digests instead.
2818 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002821
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002822/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002823 * \def MBEDTLS_SHA224_C
2824 *
2825 * Enable the SHA-224 cryptographic hash algorithm.
2826 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002827 * Requires: MBEDTLS_SHA256_C. The library does not currently support enabling
Mateusz Starzykc722ebb2021-05-11 10:05:45 +02002828 * SHA-224 without SHA-256.
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002829 *
2830 * Module: library/sha256.c
2831 * Caller: library/md.c
2832 * library/ssl_cookie.c
2833 *
2834 * This module adds support for SHA-224.
2835 */
2836#define MBEDTLS_SHA224_C
2837
2838/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002839 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002840 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002841 * Enable the SHA-256 cryptographic hash algorithm.
2842 *
Mateusz Starzyk9d2d6c92021-05-18 15:54:20 +02002843 * Requires: MBEDTLS_SHA224_C. The library does not currently support enabling
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002844 * SHA-256 without SHA-224.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002845 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002846 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002847 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002848 * library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002849 * library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002850 * library/ssl*_client.c
2851 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002852 *
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002853 * This module adds support for SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002854 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002856#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002857
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002858/**
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002859 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2860 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002861 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2862 * with the ARMv8 cryptographic extensions if they are available at runtime.
2863 * If not, the library will fall back to the C implementation.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002864 *
2865 * \note If MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT is defined when building
2866 * for a non-Aarch64 build it will be silently ignored.
2867 *
2868 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2869 * of \c -march=armv8-a+crypto.
2870 *
2871 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2872 * same time as MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY.
2873 *
2874 * Requires: MBEDTLS_SHA256_C.
2875 *
2876 * Module: library/sha256.c
2877 *
2878 * Uncomment to have the library check for the A64 SHA-256 crypto extensions
2879 * and use them if available.
2880 */
2881//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2882
2883/**
2884 * \def MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2885 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002886 * Enable acceleration of the SHA-256 and SHA-224 cryptographic hash algorithms
2887 * with the ARMv8 cryptographic extensions, which must be available at runtime
2888 * or else an illegal instruction fault will occur.
Tom Cosgrovef3ebd902022-02-20 22:25:31 +00002889 *
2890 * \note This allows builds with a smaller code size than with
2891 * MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
2892 *
2893 * \note The code uses Neon intrinsics, so \c CFLAGS must be set to a minimum
2894 * of \c -march=armv8-a+crypto.
2895 *
2896 * \warning MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY cannot be defined at the same
2897 * time as MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT.
2898 *
2899 * Requires: MBEDTLS_SHA256_C.
2900 *
2901 * Module: library/sha256.c
2902 *
2903 * Uncomment to have the library use the A64 SHA-256 crypto extensions
2904 * unconditionally.
2905 */
2906//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
2907
2908/**
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002909 * \def MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002910 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002911 * Enable the SHA-384 cryptographic hash algorithm.
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002912 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002913 * Requires: MBEDTLS_SHA512_C
2914 *
2915 * Module: library/sha512.c
2916 * Caller: library/md.c
Ronald Cronde1adee2022-03-07 16:20:30 +01002917 * library/psa_crypto_hash.c
2918 * library/ssl_tls.c
2919 * library/ssl*_client.c
2920 * library/ssl*_server.c
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002921 *
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002922 * Comment to disable SHA-384
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002923 */
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002924#define MBEDTLS_SHA384_C
Mateusz Starzyke3c48b42021-04-19 16:46:28 +02002925
2926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002927 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002928 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002929 * Enable SHA-512 cryptographic hash algorithms.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002930 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002931 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002932 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002933 * library/md.c
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02002934 * library/ssl_tls.c
2935 * library/ssl_cookie.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002936 *
Mateusz Starzyk3352a532021-04-06 14:28:22 +02002937 * This module adds support for SHA-512.
Paul Bakker5121ce52009-01-03 21:22:43 +00002938 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002940
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002941/**
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002942 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2943 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002944 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
2945 * with the ARMv8 cryptographic extensions if they are available at runtime.
2946 * If not, the library will fall back to the C implementation.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002947 *
2948 * \note If MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT is defined when building
2949 * for a non-Aarch64 build it will be silently ignored.
2950 *
2951 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
2952 * Clang >= 7, and \c CFLAGS must be set to a minimum of
2953 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
2954 * fastest code.
2955 *
2956 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT cannot be defined at the
2957 * same time as MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY.
2958 *
2959 * Requires: MBEDTLS_SHA512_C.
2960 *
2961 * Module: library/sha512.c
2962 *
2963 * Uncomment to have the library check for the A64 SHA-512 crypto extensions
2964 * and use them if available.
2965 */
2966//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2967
2968/**
2969 * \def MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
2970 *
Gilles Peskine9b3278b2022-06-09 19:09:38 +02002971 * Enable acceleration of the SHA-512 and SHA-384 cryptographic hash algorithms
2972 * with the ARMv8 cryptographic extensions, which must be available at runtime
2973 * or else an illegal instruction fault will occur.
Tom Cosgrove87fbfb52022-03-15 10:51:52 +00002974 *
2975 * \note This allows builds with a smaller code size than with
2976 * MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
2977 *
2978 * \note The code uses the SHA-512 Neon intrinsics, so requires GCC >= 8 or
2979 * Clang >= 7, and \c CFLAGS must be set to a minimum of
2980 * \c -march=armv8.2-a+sha3. An optimisation level of \c -O3 generates the
2981 * fastest code.
2982 *
2983 * \warning MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY cannot be defined at the same
2984 * time as MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT.
2985 *
2986 * Requires: MBEDTLS_SHA512_C.
2987 *
2988 * Module: library/sha512.c
2989 *
2990 * Uncomment to have the library use the A64 SHA-512 crypto extensions
2991 * unconditionally.
2992 */
2993//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
2994
2995/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002996 * \def MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00002997 *
2998 * Enable simple SSL cache implementation.
2999 *
3000 * Module: library/ssl_cache.c
3001 * Caller:
3002 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003 * Requires: MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003004 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003005#define MBEDTLS_SSL_CACHE_C
Paul Bakker0a597072012-09-25 21:55:46 +00003006
3007/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003008 * \def MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003009 *
3010 * Enable basic implementation of DTLS cookies for hello verification.
3011 *
3012 * Module: library/ssl_cookie.c
3013 * Caller:
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003014 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#define MBEDTLS_SSL_COOKIE_C
Manuel Pégourié-Gonnarda64acd42014-07-23 18:30:45 +02003016
3017/**
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003018 * \def MBEDTLS_SSL_TICKET_C
3019 *
3020 * Enable an implementation of TLS server-side callbacks for session tickets.
3021 *
3022 * Module: library/ssl_ticket.c
3023 * Caller:
Manuel Pégourié-Gonnard0c0f11f2015-05-20 09:55:50 +02003024 *
Przemek Stekiela09f8352022-05-12 09:34:28 +02003025 * Requires: MBEDTLS_CIPHER_C || MBEDTLS_USE_PSA_CRYPTO
Manuel Pégourié-Gonnardfd6d8972015-05-15 12:09:00 +02003026 */
3027#define MBEDTLS_SSL_TICKET_C
3028
3029/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003030 * \def MBEDTLS_SSL_CLI_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003031 *
3032 * Enable the SSL/TLS client code.
3033 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003034 * Module: library/ssl*_client.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003035 * Caller:
3036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003038 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003039 * This module is required for SSL/TLS client support.
3040 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003041#define MBEDTLS_SSL_CLI_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003042
Paul Bakker9a736322012-11-14 12:39:52 +00003043/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003044 * \def MBEDTLS_SSL_SRV_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003045 *
3046 * Enable the SSL/TLS server code.
3047 *
Ronald Cronde1adee2022-03-07 16:20:30 +01003048 * Module: library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003049 * Caller:
3050 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051 * Requires: MBEDTLS_SSL_TLS_C
Paul Bakker5690efc2011-05-26 13:16:06 +00003052 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003053 * This module is required for SSL/TLS server support.
3054 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055#define MBEDTLS_SSL_SRV_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003056
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003057/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003058 * \def MBEDTLS_SSL_TLS_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003059 *
Paul Bakkere29ab062011-05-18 13:26:54 +00003060 * Enable the generic SSL/TLS code.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003061 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003062 * Module: library/ssl_tls.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003063 * Caller: library/ssl*_client.c
3064 * library/ssl*_server.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003065 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003066 * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C
3067 * and at least one of the MBEDTLS_SSL_PROTO_XXX defines
Paul Bakker5690efc2011-05-26 13:16:06 +00003068 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003069 * This module is required for SSL/TLS.
3070 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#define MBEDTLS_SSL_TLS_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003072
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003073/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003074 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003075 *
3076 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003077 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02003078 * contexts are not shared between threads. If you do intend to use contexts
3079 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003080 * conditions. See also our Knowledge Base article about threading:
3081 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02003082 *
3083 * Module: library/threading.c
3084 *
3085 * This allows different threading implementations (self-implemented or
3086 * provided).
3087 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * You will have to enable either MBEDTLS_THREADING_ALT or
3089 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02003090 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00003091 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02003092 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02003094
3095/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003096 * \def MBEDTLS_TIMING_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003097 *
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003098 * Enable the semi-portable timing interface.
3099 *
Simon Butcherd567a232016-03-09 20:19:21 +00003100 * \note The provided implementation only works on POSIX/Unix (including Linux,
3101 * BSD and OS X) and Windows. On other platforms, you can either disable that
Manuel Pégourié-Gonnard325ce092016-02-22 10:33:34 +01003102 * module and provide your own implementations of the callbacks needed by
3103 * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide
3104 * your own implementation of the whole module by setting
3105 * \c MBEDTLS_TIMING_ALT in the current file.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003106 *
Andrzej Kurek57353692022-04-07 08:08:21 -04003107 * \note The timing module will include time.h on suitable platforms
3108 * regardless of the setting of MBEDTLS_HAVE_TIME, unless
3109 * MBEDTLS_TIMING_ALT is used. See timing.c for more information.
3110 *
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00003111 * \note See also our Knowledge Base article about porting to a new
3112 * environment:
3113 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
3114 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003115 * Module: library/timing.c
Paul Bakkerecd54fb2013-07-03 14:48:29 +02003116 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003117#define MBEDTLS_TIMING_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003118
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003119/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003120 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003121 *
3122 * Enable run-time version information.
3123 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00003124 * Module: library/version.c
3125 *
3126 * This module provides run-time version information.
3127 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003128#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00003129
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003130/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003131 * \def MBEDTLS_X509_USE_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003132 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003133 * Enable X.509 core for using certificates.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003134 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003135 * Module: library/x509.c
Simon Butcher2cb47392016-11-04 12:23:11 +00003136 * Caller: library/x509_crl.c
3137 * library/x509_crt.c
3138 * library/x509_csr.c
Paul Bakker5121ce52009-01-03 21:22:43 +00003139 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003140 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003141 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3142 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003143 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3144 * psa_crypto_init() before doing any X.509 operation.
Paul Bakker5690efc2011-05-26 13:16:06 +00003145 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003146 * This module is required for the X.509 parsing modules.
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148#define MBEDTLS_X509_USE_C
Paul Bakker5121ce52009-01-03 21:22:43 +00003149
Paul Bakkerf3b86c12011-01-27 15:24:17 +00003150/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003151 * \def MBEDTLS_X509_CRT_PARSE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003152 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003153 * Enable X.509 certificate parsing.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003154 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003155 * Module: library/x509_crt.c
Ronald Cronde1adee2022-03-07 16:20:30 +01003156 * Caller: library/ssl_tls.c
3157 * library/ssl*_client.c
3158 * library/ssl*_server.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003159 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003160 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003161 *
3162 * This module is required for X.509 certificate parsing.
3163 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003164#define MBEDTLS_X509_CRT_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003165
3166/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003167 * \def MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003168 *
3169 * Enable X.509 CRL parsing.
3170 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003171 * Module: library/x509_crl.c
3172 * Caller: library/x509_crt.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003173 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003175 *
3176 * This module is required for X.509 CRL parsing.
3177 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178#define MBEDTLS_X509_CRL_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003179
3180/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003181 * \def MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003182 *
3183 * Enable X.509 Certificate Signing Request (CSR) parsing.
3184 *
Simon Butcher2cb47392016-11-04 12:23:11 +00003185 * Module: library/x509_csr.c
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003186 * Caller: library/x509_crt_write.c
3187 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 * Requires: MBEDTLS_X509_USE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003189 *
3190 * This module is used for reading X.509 certificate request.
3191 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003192#define MBEDTLS_X509_CSR_PARSE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003193
3194/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195 * \def MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003196 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003197 * Enable X.509 core for creating certificates.
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003198 *
3199 * Module: library/x509_create.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003200 *
Przemek Stekiel10836a02022-08-19 08:45:34 +02003201 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_PARSE_C,
Przemek Stekiel278b6672022-08-03 09:50:38 +02003202 * (MBEDTLS_MD_C or MBEDTLS_USE_PSA_CRYPTO)
3203 *
Manuel Pégourié-Gonnard72687b72022-09-15 12:23:58 +02003204 * \warning If building with MBEDTLS_USE_PSA_CRYPTO, you must call
3205 * psa_crypto_init() before doing any X.509 create operation.
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003206 *
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003207 * This module is the basis for creating X.509 certificates and CSRs.
3208 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003209#define MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003210
3211/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212 * \def MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003213 *
3214 * Enable creating X.509 certificates.
3215 *
3216 * Module: library/x509_crt_write.c
3217 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003218 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003219 *
3220 * This module is required for X.509 certificate creation.
3221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222#define MBEDTLS_X509_CRT_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003223
3224/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003225 * \def MBEDTLS_X509_CSR_WRITE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003226 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02003227 * Enable creating X.509 Certificate Signing Requests (CSR).
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003228 *
3229 * Module: library/x509_csr_write.c
3230 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003231 * Requires: MBEDTLS_X509_CREATE_C
Paul Bakker7c6b2c32013-09-16 13:49:26 +02003232 *
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003233 * This module is required for X.509 certificate request writing.
3234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003235#define MBEDTLS_X509_CSR_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00003236
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +01003237/** \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00003238
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003239/**
Gilles Peskineba4162a2022-04-11 17:04:38 +02003240 * \name SECTION: General configuration options
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003241 *
Gilles Peskined5793ce2022-04-13 23:05:10 +02003242 * This section contains Mbed TLS build settings that are not associated
3243 * with a particular module.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003244 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003245 * \{
3246 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003247
Gilles Peskinea02c1242022-03-16 17:03:19 +01003248/**
3249 * \def MBEDTLS_CONFIG_FILE
3250 *
3251 * If defined, this is a header which will be included instead of
3252 * `"mbedtls/mbedtls_config.h"`.
3253 * This header file specifies the compile-time configuration of Mbed TLS.
Gilles Peskineefffd642022-04-26 18:13:01 +02003254 * Unlike other configuration options, this one must be defined on the
3255 * compiler command line: a definition in `mbedtls_config.h` would have
3256 * no effect.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003257 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003258 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003259 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003260 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003261 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003262 * The value of this symbol is typically a path in double quotes, either
3263 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003264 */
3265//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
3266
3267/**
3268 * \def MBEDTLS_USER_CONFIG_FILE
3269 *
3270 * If defined, this is a header which will be included after
3271 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003272 * This allows you to modify the default configuration, including the ability
3273 * to undefine options that are enabled by default.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003274 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003275 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinea02c1242022-03-16 17:03:19 +01003276 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003277 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003278 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003279 * The value of this symbol is typically a path in double quotes, either
3280 * absolute or relative to a directory on the include search path.
Gilles Peskinea02c1242022-03-16 17:03:19 +01003281 */
3282//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
3283
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003284/**
3285 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE
3286 *
3287 * If defined, this is a header which will be included instead of
3288 * `"psa/crypto_config.h"`.
3289 * This header file specifies which cryptographic mechanisms are available
3290 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and
3291 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled.
3292 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003293 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003294 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003295 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003296 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003297 * The value of this symbol is typically a path in double quotes, either
3298 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003299 */
3300//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
3301
3302/**
3303 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE
3304 *
3305 * If defined, this is a header which will be included after
3306 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE.
Gilles Peskinef68f43a2022-04-13 23:22:20 +02003307 * This allows you to modify the default configuration, including the ability
3308 * to undefine options that are enabled by default.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003309 *
Gilles Peskine6457ef92022-04-11 16:42:37 +02003310 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003311 * non-standard feature of the C language, so this feature is only available
Gilles Peskine6457ef92022-04-11 16:42:37 +02003312 * with compilers that perform macro expansion on an <tt>\#include</tt> line.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003313 *
Gilles Peskine58ffcba2022-04-14 12:44:16 +02003314 * The value of this symbol is typically a path in double quotes, either
3315 * absolute or relative to a directory on the include search path.
Gilles Peskinef4c6eb02022-03-16 17:10:48 +01003316 */
3317//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
3318
Gilles Peskineba4162a2022-04-11 17:04:38 +02003319/** \} name SECTION: General configuration options */
3320
3321/**
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003322 * \name SECTION: Module configuration options
3323 *
3324 * This section allows for the setting of module specific sizes and
3325 * configuration options. The default values are already present in the
3326 * relevant header files and should suffice for the regular use cases.
3327 *
3328 * Our advice is to enable options and change their values here
3329 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003330 * \{
3331 */
Gilles Peskine3f49cc12022-04-13 23:21:16 +02003332/* The Doxygen documentation here is used when a user comments out a
3333 * setting and runs doxygen themselves. On the other hand, when we typeset
3334 * the full documentation including disabled settings, the documentation
3335 * in specific modules' header files is used if present. When editing this
3336 * file, make sure that each option is documented in exactly one place,
3337 * plus optionally a same-line Doxygen comment here if there is a Doxygen
3338 * comment in the specific module. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003339
Paul Bakker088c5c52014-04-25 11:11:10 +02003340/* MPI / BIGNUM options */
Daniel Otte4374dc42020-09-07 13:06:40 +02003341//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum window size used. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003342//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003343
Paul Bakker088c5c52014-04-25 11:11:10 +02003344/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003345//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
3346//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3347//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3348//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3349//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003350
Paul Bakker088c5c52014-04-25 11:11:10 +02003351/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
3353//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
3354//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
3355//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003356
Paul Bakker088c5c52014-04-25 11:11:10 +02003357/* ECP options */
Gilles Peskine5752e592021-06-02 13:27:03 +02003358//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01003360
Paul Bakker088c5c52014-04-25 11:11:10 +02003361/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
3363//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01003364//#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 +01003365
Paul Bakker088c5c52014-04-25 11:11:10 +02003366/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003368
Paul Bakker088c5c52014-04-25 11:11:10 +02003369/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003370//#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 +02003371//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003373//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf /**< Default setbuf to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003375//#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 +02003376//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
3377//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003378/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00003380//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
3381//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003382//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3383//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
3384//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02003385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
3387/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02003388//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
3390//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Gilles Peskine6497b5a2022-06-30 17:01:40 +02003391//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf /**< Default setbuf macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01003392//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
3393//#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 +02003394//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
3395//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01003396/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003397//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02003398//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01003399//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
3400//#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 +02003401
Gilles Peskine3f106f72021-09-23 17:42:39 +02003402/** \def MBEDTLS_CHECK_RETURN
3403 *
3404 * This macro is used at the beginning of the declaration of a function
3405 * to indicate that its return value should be checked. It should
3406 * instruct the compiler to emit a warning or an error if the function
3407 * is called without checking its return value.
3408 *
3409 * There is a default implementation for popular compilers in platform_util.h.
3410 * You can override the default implementation by defining your own here.
3411 *
3412 * If the implementation here is empty, this will effectively disable the
3413 * checking of functions' return values.
3414 */
Gilles Peskinecd79dfc2021-09-30 18:53:36 +02003415//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
Gilles Peskine3f106f72021-09-23 17:42:39 +02003416
Gilles Peskinefcc93d72021-09-30 18:56:17 +02003417/** \def MBEDTLS_IGNORE_RETURN
3418 *
3419 * This macro requires one argument, which should be a C function call.
3420 * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this
3421 * warning is suppressed.
3422 */
3423//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
3424
Gilles Peskineed038902020-11-13 21:33:21 +01003425/* PSA options */
Gilles Peskine14c332b2020-11-14 12:26:53 +01003426/**
Gilles Peskineed038902020-11-13 21:33:21 +01003427 * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the
3428 * PSA crypto subsystem.
3429 *
3430 * If this option is unset:
3431 * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG.
Gilles Peskineb0a748e2020-11-30 12:01:54 +01003432 * - Otherwise, the PSA subsystem uses HMAC_DRBG with either
Gilles Peskineed038902020-11-13 21:33:21 +01003433 * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and
3434 * on unspecified heuristics.
3435 */
3436//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
3437
Steven Cooreman863470a2021-02-15 14:03:19 +01003438/** \def MBEDTLS_PSA_KEY_SLOT_COUNT
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003439 * Restrict the PSA library to supporting a maximum amount of simultaneously
3440 * loaded keys. A loaded key is a key stored by the PSA Crypto core as a
3441 * volatile key, or a persistent key which is loaded temporarily by the
3442 * library as part of a crypto operation in flight.
3443 *
3444 * If this option is unset, the library will fall back to a default value of
3445 * 32 keys.
3446 */
Steven Cooreman863470a2021-02-15 14:03:19 +01003447//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Steven Cooreman1f968fd2021-02-15 14:00:24 +01003448
Paul Bakker088c5c52014-04-25 11:11:10 +02003449/* SSL Cache options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */
3451//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02003452
Paul Bakker088c5c52014-04-25 11:11:10 +02003453/* SSL options */
Angus Grattond8213d02016-05-25 20:56:48 +10003454
Angus Grattond8213d02016-05-25 20:56:48 +10003455/** \def MBEDTLS_SSL_IN_CONTENT_LEN
3456 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003457 * Maximum length (in bytes) of incoming plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003458 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003459 * This determines the size of the incoming TLS I/O buffer in such a way
3460 * that it is capable of holding the specified amount of plaintext data,
3461 * regardless of the protection mechanism used.
3462 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003463 * \note When using a value less than the default of 16KB on the client, it is
3464 * recommended to use the Maximum Fragment Length (MFL) extension to
3465 * inform the server about this limitation. On the server, there
3466 * is no supported, standardized way of informing the client about
3467 * restriction on the maximum size of incoming messages, and unless
3468 * the limitation has been communicated by other means, it is recommended
3469 * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN
3470 * while keeping the default value of 16KB for the incoming buffer.
3471 *
David Horstmann95d516f2021-05-04 18:36:56 +01003472 * Uncomment to set the maximum plaintext size of the incoming I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003473 */
3474//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
3475
Gilles Peskined3d02902020-03-04 21:35:27 +01003476/** \def MBEDTLS_SSL_CID_IN_LEN_MAX
3477 *
3478 * The maximum length of CIDs used for incoming DTLS messages.
3479 *
3480 */
3481//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
3482
3483/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX
3484 *
3485 * The maximum length of CIDs used for outgoing DTLS messages.
3486 *
3487 */
3488//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
3489
TRodziewicze8dd7092021-05-12 14:19:11 +02003490/** \def MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Gilles Peskined3d02902020-03-04 21:35:27 +01003491 *
3492 * This option controls the use of record plaintext padding
TRodziewicz1e660ed2021-05-26 17:08:54 +02003493 * in TLS 1.3 and when using the Connection ID extension in DTLS 1.2.
Hanno Becker13996922020-05-28 16:15:19 +01003494 *
3495 * The padding will always be chosen so that the length of the
3496 * padded plaintext is a multiple of the value of this option.
3497 *
3498 * Note: A value of \c 1 means that no padding will be used
3499 * for outgoing records.
3500 *
3501 * Note: On systems lacking division instructions,
3502 * a power of two should be preferred.
3503 */
TRodziewicze8dd7092021-05-12 14:19:11 +02003504//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +01003505
Angus Grattond8213d02016-05-25 20:56:48 +10003506/** \def MBEDTLS_SSL_OUT_CONTENT_LEN
3507 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003508 * Maximum length (in bytes) of outgoing plaintext fragments.
Angus Grattond8213d02016-05-25 20:56:48 +10003509 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003510 * This determines the size of the outgoing TLS I/O buffer in such a way
3511 * that it is capable of holding the specified amount of plaintext data,
3512 * regardless of the protection mechanism used.
3513 *
Angus Grattond8213d02016-05-25 20:56:48 +10003514 * It is possible to save RAM by setting a smaller outward buffer, while keeping
3515 * the default inward 16384 byte buffer to conform to the TLS specification.
3516 *
3517 * The minimum required outward buffer size is determined by the handshake
3518 * protocol's usage. Handshaking will fail if the outward buffer is too small.
3519 * The specific size requirement depends on the configured ciphers and any
3520 * certificate data which is sent during the handshake.
3521 *
David Horstmann95d516f2021-05-04 18:36:56 +01003522 * Uncomment to set the maximum plaintext size of the outgoing I/O buffer.
Angus Grattond8213d02016-05-25 20:56:48 +10003523 */
3524//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
3525
Hanno Beckere0b150f2018-08-21 15:51:03 +01003526/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING
3527 *
3528 * Maximum number of heap-allocated bytes for the purpose of
3529 * DTLS handshake message reassembly and future message buffering.
3530 *
Yuto Takano7828ca22021-08-10 11:26:15 +01003531 * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN
Hanno Becker28007512018-08-28 09:46:44 +01003532 * to account for a reassembled handshake message of maximum size,
3533 * together with its reassembly bitmap.
3534 *
Hanno Becker97a1c132018-08-28 14:42:15 +01003535 * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default)
Hanno Becker28007512018-08-28 09:46:44 +01003536 * should be sufficient for all practical situations as it allows
3537 * to reassembly a large handshake message (such as a certificate)
3538 * while buffering multiple smaller handshake messages.
3539 *
Hanno Beckere0b150f2018-08-21 15:51:03 +01003540 */
Hanno Becker159a37f2018-08-24 15:07:29 +01003541//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +01003542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */
3544//#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 +02003545
Gilles Peskine7dd2f502021-04-24 13:35:41 +02003546/** \def MBEDTLS_TLS_EXT_CID
3547 *
3548 * At the time of writing, the CID extension has not been assigned its
3549 * final value. Set this configuration option to make Mbed TLS use a
3550 * different value.
3551 *
3552 * A future minor revision of Mbed TLS may change the default value of
3553 * this option to match evolving standards and usage.
3554 */
3555//#define MBEDTLS_TLS_EXT_CID 254
3556
Manuel Pégourié-Gonnarddfc7df02014-06-30 17:59:55 +02003557/**
3558 * Complete list of ciphersuites to use, in order of preference.
3559 *
3560 * \warning No dependency checking is done on that field! This option can only
3561 * be used to restrict the set of available ciphersuites. It is your
3562 * responsibility to make sure the needed modules are active.
3563 *
3564 * Use this to save a few hundred bytes of ROM (default ordering of all
3565 * available ciphersuites) and a few to a few hundred bytes of RAM.
3566 *
3567 * The value below is only an example, not the default.
3568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569//#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 +02003570
Manuel Pégourié-Gonnardfd6c85c2014-11-20 16:34:20 +01003571/* X509 options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003572//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */
Andres AGf9113192016-09-02 14:06:04 +01003573//#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 +01003574
Gilles Peskine5e79cb32017-05-04 16:17:21 +02003575/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003576 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003577 * mbedtls_platform_zeroize(). This replaces the default implementation in
3578 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00003579 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003580 * mbedtls_platform_zeroize() is a widely used function across the library to
3581 * zero a block of memory. The implementation is expected to be secure in the
3582 * sense that it has been written to prevent the compiler from removing calls
3583 * to mbedtls_platform_zeroize() as part of redundant code elimination
3584 * optimizations. However, it is difficult to guarantee that calls to
3585 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
3586 * versions of the C language standards do not provide a secure implementation
3587 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
3588 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05003589 * example by using directives specific to their compiler, features from newer
3590 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003591 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003592 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05003593//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01003594
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003595/**
3596 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01003597 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003598 * platform_util.c.
3599 *
Hanno Becker921b76d2018-09-05 16:21:36 +01003600 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003601 * library will try to use safer implementations of this function, such as
3602 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01003603 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003604 * using the standard gmtime(). In this case, calls from the library to
3605 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01003606 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003607 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01003608 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
3609 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
3610 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003611 */
Hanno Becker6a739782018-09-05 15:06:19 +01003612//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01003613
Christoph M. Wintersteigere50b9702018-12-14 11:03:02 +00003614/**
Christoph M. Wintersteiger50d9f092019-02-15 12:49:27 +00003615 * Enable the verified implementations of ECDH primitives from Project Everest
3616 * (currently only Curve25519). This feature changes the layout of ECDH
3617 * contexts and therefore is a compatibility break for applications that access
3618 * fields of a mbedtls_ecdh_context structure directly. See also
3619 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003620 */
Christoph M. Wintersteiger6cddd302019-01-17 12:17:54 +00003621//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteiger02b80482018-10-25 12:41:04 +01003622
Gilles Peskine611179c2022-04-13 23:04:48 +02003623/** \} name SECTION: Module configuration options */