blob: f8788d89d35ee9cb7c465b6ba7ea071cd2bfb0a8 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02002 * \file config.h
Paul Bakker5121ce52009-01-03 21:22:43 +00003 *
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02004 * \brief Configuration options (set of defines)
Paul Bakker37ca75d2011-01-06 12:28:03 +00005 *
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02006 * 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/*
Thomas Fossati656864b2016-07-17 08:51:22 +010011 * Copyright (C) 2006-2018, ARM Limited, All Rights Reserved
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.
Paul Bakkerb96f1542010-07-18 20:36:00 +000025 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000026 * This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnarde2b0efe2015-08-11 10:38:37 +020027 */
28
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#ifndef MBEDTLS_CONFIG_H
30#define MBEDTLS_CONFIG_H
Paul Bakker5121ce52009-01-03 21:22:43 +000031
Paul Bakkercce9d772011-11-18 14:26:47 +000032#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
Paul Bakker5121ce52009-01-03 21:22:43 +000033#define _CRT_SECURE_NO_DEPRECATE 1
34#endif
35
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
Paul Bakker68041ec2009-04-19 21:17:55 +000052 * library/timing.c
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000053 * include/mbedtls/bn_mul.h
Paul Bakker68041ec2009-04-19 21:17:55 +000054 *
Manuel Pégourié-Gonnard26b54fa2018-02-27 12:20:20 +010055 * Required by:
56 * MBEDTLS_AESNI_C
57 * MBEDTLS_PADLOCK_C
58 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +020059 * Comment to disable the use of assembly code.
Paul Bakker5121ce52009-01-03 21:22:43 +000060 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020061#define MBEDTLS_HAVE_ASM
Paul Bakker5121ce52009-01-03 21:22:43 +000062
Paul Bakkerf3b86c12011-01-27 15:24:17 +000063/**
Gilles Peskineb1a977f2017-06-08 15:19:20 +020064 * \def MBEDTLS_NO_UDBL_DIVISION
65 *
66 * The platform lacks support for double-width integer division (64-bit
67 * division on a 32-bit platform, 128-bit division on a 64-bit platform).
68 *
69 * Used in:
70 * include/mbedtls/bignum.h
71 * library/bignum.c
72 *
73 * The bignum code uses double-width division to speed up some operations.
74 * Double-width division is often implemented in software that needs to
75 * be linked with the program. The presence of a double-width integer
76 * type is usually detected automatically through preprocessor macros,
77 * but the automatic detection cannot know whether the code needs to
78 * and can be linked with an implementation of division for that type.
79 * By default division is assumed to be usable if the type is present.
80 * Uncomment this option to prevent the use of double-width division.
81 *
82 * Note that division for the native integer type is always required.
83 * Furthermore, a 64-bit type is always required even on a 32-bit
Andres Amaya Garciac630ce62017-07-21 10:56:22 +010084 * platform, but it need not support multiplication or division. In some
85 * cases it is also desirable to disable some double-width operations. For
86 * example, if double-width division is implemented in software, disabling
87 * it can reduce code size in some embedded targets.
Gilles Peskineb1a977f2017-06-08 15:19:20 +020088 */
89//#define MBEDTLS_NO_UDBL_DIVISION
90
91/**
Manuel Pégourié-Gonnard2adb3752018-06-07 10:51:44 +020092 * \def MBEDTLS_NO_64BIT_MULTIPLICATION
93 *
94 * The platform lacks support for 32x32 -> 64-bit multiplication.
95 *
96 * Used in:
97 * library/poly1305.c
98 *
99 * Some parts of the library may use multiplication of two unsigned 32-bit
100 * operands with a 64-bit result in order to speed up computations. On some
101 * platforms, this is not available in hardware and has to be implemented in
102 * software, usually in a library provided by the toolchain.
103 *
104 * Sometimes it is not desirable to have to link to that library. This option
105 * removes the dependency of that library on platforms that lack a hardware
106 * 64-bit multiplier by embedding a software implementation in Mbed TLS.
107 *
108 * Note that depending on the compiler, this may decrease performance compared
109 * to using the library function provided by the toolchain.
110 */
111//#define MBEDTLS_NO_64BIT_MULTIPLICATION
112
113/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200114 * \def MBEDTLS_HAVE_SSE2
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000115 *
Paul Bakkere23c3152012-10-01 14:42:47 +0000116 * CPU supports SSE2 instruction set.
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000117 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 * Uncomment if the CPU supports SSE2 (IA-32 specific).
Paul Bakker5121ce52009-01-03 21:22:43 +0000119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200120//#define MBEDTLS_HAVE_SSE2
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200121
122/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200123 * \def MBEDTLS_HAVE_TIME
124 *
125 * System has time.h and time().
126 * The time does not need to be correct, only time differences are used,
127 * by contrast with MBEDTLS_HAVE_TIME_DATE
128 *
129 * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT,
130 * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and
131 * MBEDTLS_PLATFORM_STD_TIME.
132 *
133 * Comment if your system does not support time functions
134 */
135#define MBEDTLS_HAVE_TIME
136
137/**
138 * \def MBEDTLS_HAVE_TIME_DATE
139 *
Hanno Becker4e67cca2018-09-05 16:18:38 +0100140 * System has time.h, time(), and an implementation for
141 * mbedtls_platform_gmtime_r() (see below).
Antonin Décimo36e89b52019-01-23 15:24:37 +0100142 * The time needs to be correct (not necessarily very accurate, but at least
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200143 * the date should be correct). This is used to verify the validity period of
144 * X.509 certificates.
145 *
146 * Comment if your system does not have a correct clock.
Andres Amaya Garcia97f3ecb2018-08-07 20:39:27 +0100147 *
Hanno Becker6a739782018-09-05 15:06:19 +0100148 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
Hanno Beckerc52ef402018-09-05 16:28:59 +0100149 * behaves similarly to the gmtime_r() function from the C standard. Refer to
150 * the documentation for mbedtls_platform_gmtime_r() for more information.
Andres Amaya Garciac99b12b2018-08-21 19:32:44 +0100151 *
152 * \note It is possible to configure an implementation for
Hanno Becker6a739782018-09-05 15:06:19 +0100153 * mbedtls_platform_gmtime_r() at compile-time by using the macro
154 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200155 */
156#define MBEDTLS_HAVE_TIME_DATE
157
158/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159 * \def MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100160 *
161 * Enable the memory allocation layer.
162 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200163 * By default mbed TLS uses the system-provided calloc() and free().
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100164 * This allows different allocators (self-implemented or provided) to be
165 * provided to the platform abstraction layer.
166 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167 * Enabling MBEDTLS_PLATFORM_MEMORY without the
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200168 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
169 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
Rich Evans16f8cd82015-02-06 16:14:34 +0000170 * free() function pointer at runtime.
171 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200173 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
Rich Evans16f8cd82015-02-06 16:14:34 +0000174 * alternate function at compile time.
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100175 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176 * Requires: MBEDTLS_PLATFORM_C
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100177 *
178 * Enable this layer to allow use of alternative memory allocators.
179 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180//#define MBEDTLS_PLATFORM_MEMORY
Paul Bakkerdefc0ca2014-02-04 17:30:24 +0100181
182/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200184 *
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +0200185 * Do not assign standard functions in the platform layer (e.g. calloc() to
186 * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF)
Paul Bakker088c5c52014-04-25 11:11:10 +0200187 *
188 * This makes sure there are no linking errors on platforms that do not support
189 * these functions. You will HAVE to provide alternatives, either at runtime
190 * via the platform_set_xxx() functions or at compile time by setting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
192 * MBEDTLS_PLATFORM_XXX_MACRO.
Paul Bakker088c5c52014-04-25 11:11:10 +0200193 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194 * Requires: MBEDTLS_PLATFORM_C
Paul Bakker088c5c52014-04-25 11:11:10 +0200195 *
196 * Uncomment to prevent default assignment of standard functions in the
197 * platform layer.
198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200199//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
Paul Bakker088c5c52014-04-25 11:11:10 +0200200
201/**
Janos Follathc351d182016-03-21 08:43:59 +0000202 * \def MBEDTLS_PLATFORM_EXIT_ALT
Paul Bakker747a83a2014-02-01 22:50:07 +0100203 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100204 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
205 * function in the platform abstraction layer.
Paul Bakker747a83a2014-02-01 22:50:07 +0100206 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200207 * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, mbed TLS will
208 * provide a function "mbedtls_platform_set_printf()" that allows you to set an
Paul Bakker747a83a2014-02-01 22:50:07 +0100209 * alternative printf function pointer.
210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211 * All these define require MBEDTLS_PLATFORM_C to be defined!
Paul Bakker747a83a2014-02-01 22:50:07 +0100212 *
Manuel Pégourié-Gonnard9db28872015-06-26 10:52:01 +0200213 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
214 * it will be enabled automatically by check_config.h
215 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +0200216 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217 * MBEDTLS_PLATFORM_XXX_MACRO!
Rich Evans16f8cd82015-02-06 16:14:34 +0000218 *
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200219 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
220 *
Paul Bakker747a83a2014-02-01 22:50:07 +0100221 * Uncomment a macro to enable alternate implementation of specific base
222 * platform function
223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224//#define MBEDTLS_PLATFORM_EXIT_ALT
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200225//#define MBEDTLS_PLATFORM_TIME_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226//#define MBEDTLS_PLATFORM_FPRINTF_ALT
227//#define MBEDTLS_PLATFORM_PRINTF_ALT
228//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
k-stachowiak723f8672018-07-16 14:27:07 +0200229//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100230//#define MBEDTLS_PLATFORM_NV_SEED_ALT
Andres Amaya Garciad91f99f2017-07-18 10:23:04 +0100231//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100232
233/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234 * \def MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100235 *
236 * Mark deprecated functions so that they generate a warning if used.
237 * Functions deprecated in one version will usually be removed in the next
238 * version. You can enable this to help you prepare the transition to a new
239 * major version by making sure your code is not using these functions.
240 *
241 * This only works with GCC and Clang. With other compilers, you may want to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242 * use MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100243 *
244 * Uncomment to get warnings on using deprecated functions.
245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246//#define MBEDTLS_DEPRECATED_WARNING
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100247
248/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249 * \def MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100250 *
251 * Remove deprecated functions so that they generate an error if used.
252 * Functions deprecated in one version will usually be removed in the next
253 * version. You can enable this to help you prepare the transition to a new
254 * major version by making sure your code is not using these functions.
255 *
256 * Uncomment to get errors on using deprecated functions.
257 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258//#define MBEDTLS_DEPRECATED_REMOVED
Manuel Pégourié-Gonnardc70581c2015-03-23 13:58:27 +0100259
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500260/**
261 * \def MBEDTLS_CHECK_PARAMS
262 *
263 * This configuration option controls whether the library validates more of
264 * the parameters passed to it.
265 *
266 * When this flag is not defined, the library only attempts to validate an
267 * input parameter if: (1) they may come from the outside world (such as the
268 * network, the filesystem, etc.) or (2) not validating them could result in
269 * internal memory errors such as overflowing a buffer controlled by the
270 * library. On the other hand, it doesn't attempt to validate parameters whose
271 * values are fully controlled by the application (such as pointers).
272 *
273 * When this flag is defined, the library additionally attempts to validate
274 * parameters that are fully controlled by the application, and should always
275 * be valid if the application code is fully correct and trusted.
276 *
277 * For example, when a function accepts as input a pointer to a buffer that may
278 * contain untrusted data, and its documentation mentions that this pointer
279 * must not be NULL:
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200280 * - The pointer is checked to be non-NULL only if this option is enabled.
281 * - The content of the buffer is always validated.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500282 *
283 * When this flag is defined, if a library function receives a parameter that
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200284 * is invalid:
285 * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED().
286 * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function
287 * will immediately return. If the function returns an Mbed TLS error code,
288 * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500289 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200290 * When defining this flag, you also need to arrange a definition for
291 * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods:
292 * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a
293 * function mbedtls_param_failed(), but the library does not define this
294 * function. If you do not make any other arrangements, you must provide
295 * the function mbedtls_param_failed() in your application.
296 * See `platform_util.h` for its prototype.
297 * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the
Jaeden Amero8dd16902019-07-22 16:39:49 +0100298 * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`.
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200299 * You can still supply an alternative definition of
300 * MBEDTLS_PARAM_FAILED(), which may call `assert`.
301 * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h`
302 * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`,
303 * the library will call the macro that you defined and will not supply
304 * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`,
305 * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source
306 * files include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500307 *
308 * Uncomment to enable validation of application-controlled parameters.
309 */
310//#define MBEDTLS_CHECK_PARAMS
311
Gilles Peskinec7ad1222019-06-13 16:44:19 +0200312/**
313 * \def MBEDTLS_CHECK_PARAMS_ASSERT
314 *
315 * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to
316 * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined.
317 *
318 * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to
319 * calling a function mbedtls_param_failed(). See the documentation of
320 * #MBEDTLS_CHECK_PARAMS for details.
321 *
322 * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`.
323 */
324//#define MBEDTLS_CHECK_PARAMS_ASSERT
325
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200326/* \} name SECTION: System support */
Paul Bakker0a62cd12011-01-21 11:00:08 +0000327
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000328/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +0000329 * \name SECTION: mbed TLS feature support
Paul Bakker0a62cd12011-01-21 11:00:08 +0000330 *
331 * This section sets support for features that are or are not needed
332 * within the modules that are enabled.
333 * \{
334 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000335
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000336/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200337 * \def MBEDTLS_TIMING_ALT
338 *
339 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
340 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
341 *
342 * Only works if you have MBEDTLS_TIMING_C enabled.
343 *
344 * You will need to provide a header "timing_alt.h" and an implementation at
345 * compile time.
346 */
347//#define MBEDTLS_TIMING_ALT
348
349/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100350 * \def MBEDTLS_AES_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200351 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100352 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follathb0697532016-08-18 12:38:46 +0100353 * alternate core implementation of a symmetric crypto, an arithmetic or hash
354 * module (e.g. platform specific assembly optimized implementations). Keep
355 * in mind that the function prototypes should remain the same.
Paul Bakker90995b52013-06-24 19:20:35 +0200356 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200357 * This replaces the whole module. If you only want to replace one of the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200358 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200359 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
Janos Follathee782bc2016-11-07 15:41:26 +0000361 * provide the "struct mbedtls_aes_context" definition and omit the base
362 * function declarations and implementations. "aes_alt.h" will be included from
Paul Bakker90995b52013-06-24 19:20:35 +0200363 * "aes.h" to include the new function definitions.
364 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200365 * Uncomment a macro to enable alternate implementation of the corresponding
366 * module.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100367 *
368 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
369 * use constitutes a security risk. If possible, we recommend
370 * avoiding dependencies on them, and considering stronger message
371 * digests and ciphers instead.
372 *
Paul Bakker90995b52013-06-24 19:20:35 +0200373 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200374//#define MBEDTLS_AES_ALT
375//#define MBEDTLS_ARC4_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000376//#define MBEDTLS_ARIA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377//#define MBEDTLS_BLOWFISH_ALT
378//#define MBEDTLS_CAMELLIA_ALT
Steven Cooreman222e2ff2017-04-04 11:37:15 +0200379//#define MBEDTLS_CCM_ALT
Daniel King34b822c2016-05-15 17:28:08 -0300380//#define MBEDTLS_CHACHA20_ALT
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +0200381//#define MBEDTLS_CHACHAPOLY_ALT
Steven Cooreman63342772017-04-04 11:47:16 +0200382//#define MBEDTLS_CMAC_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383//#define MBEDTLS_DES_ALT
nirekh01d569ecf2018-01-09 16:43:21 +0000384//#define MBEDTLS_DHM_ALT
Hanno Becker616d1ca2018-01-24 10:25:05 +0000385//#define MBEDTLS_ECJPAKE_ALT
Jaeden Amero15263302017-09-21 12:53:48 +0100386//#define MBEDTLS_GCM_ALT
Ron Eldor466a57f2018-05-03 16:54:28 +0300387//#define MBEDTLS_NIST_KW_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388//#define MBEDTLS_MD2_ALT
389//#define MBEDTLS_MD4_ALT
390//#define MBEDTLS_MD5_ALT
Daniel Kingadc32c02016-05-16 18:25:45 -0300391//#define MBEDTLS_POLY1305_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392//#define MBEDTLS_RIPEMD160_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000393//#define MBEDTLS_RSA_ALT
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394//#define MBEDTLS_SHA1_ALT
395//#define MBEDTLS_SHA256_ALT
396//#define MBEDTLS_SHA512_ALT
Hanno Becker88683b22018-01-04 18:26:54 +0000397//#define MBEDTLS_XTEA_ALT
Markku-Juhani O. Saarinen0fb47fe2017-12-01 15:41:38 +0000398
Janos Follathb0697532016-08-18 12:38:46 +0100399/*
400 * When replacing the elliptic curve module, pleace consider, that it is
401 * implemented with two .c files:
402 * - ecp.c
403 * - ecp_curves.c
Janos Follathee782bc2016-11-07 15:41:26 +0000404 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
405 * macros as described above. The only difference is that you have to make sure
406 * that you provide functionality for both .c files.
Janos Follathb0697532016-08-18 12:38:46 +0100407 */
408//#define MBEDTLS_ECP_ALT
Paul Bakker90995b52013-06-24 19:20:35 +0200409
410/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100411 * \def MBEDTLS_MD2_PROCESS_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200412 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100413 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
414 * alternate core implementation of symmetric crypto or hash function. Keep in
415 * mind that function prototypes should remain the same.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200416 *
417 * This replaces only one function. The header file from mbed TLS is still
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200419 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
421 * no longer provide the mbedtls_sha1_process() function, but it will still provide
422 * the other function (using your mbedtls_sha1_process() function) and the definition
423 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200424 * with this definition.
425 *
Hanno Becker6d84ae72017-06-26 12:46:19 +0100426 * \note Because of a signature change, the core AES encryption and decryption routines are
427 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
428 * respectively. When setting up alternative implementations, these functions should
Antonin Décimo36e89b52019-01-23 15:24:37 +0100429 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Hanno Beckerca1cdb22017-07-20 09:50:59 +0100430 * must stay untouched.
Hanno Becker6d84ae72017-06-26 12:46:19 +0100431 *
432 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
433 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
434 * tables.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200435 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200436 * Uncomment a macro to enable alternate implementation of the corresponding
437 * function.
Hanno Beckerbbca8c52017-09-25 14:53:51 +0100438 *
439 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
440 * constitutes a security risk. If possible, we recommend avoiding
441 * dependencies on them, and considering stronger message digests
442 * and ciphers instead.
443 *
Janos Follath1231d212019-01-07 15:01:32 +0000444 * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are
445 * enabled, then the deterministic ECDH signature functions pass the
446 * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore
447 * alternative implementations should use the RNG only for generating
448 * the ephemeral key and nothing else. If this is not possible, then
449 * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative
450 * implementation should be provided for mbedtls_ecdsa_sign_det_ext()
451 * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is
452 * desirable).
453 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200454 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455//#define MBEDTLS_MD2_PROCESS_ALT
456//#define MBEDTLS_MD4_PROCESS_ALT
457//#define MBEDTLS_MD5_PROCESS_ALT
458//#define MBEDTLS_RIPEMD160_PROCESS_ALT
459//#define MBEDTLS_SHA1_PROCESS_ALT
460//#define MBEDTLS_SHA256_PROCESS_ALT
461//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200462//#define MBEDTLS_DES_SETKEY_ALT
463//#define MBEDTLS_DES_CRYPT_ECB_ALT
464//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200465//#define MBEDTLS_AES_SETKEY_ENC_ALT
466//#define MBEDTLS_AES_SETKEY_DEC_ALT
467//#define MBEDTLS_AES_ENCRYPT_ALT
468//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300469//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300470//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300471//#define MBEDTLS_ECDSA_VERIFY_ALT
472//#define MBEDTLS_ECDSA_SIGN_ALT
473//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200474
475/**
Janos Follathc44ab972016-11-18 16:38:23 +0000476 * \def MBEDTLS_ECP_INTERNAL_ALT
477 *
478 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100479 *
480 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100481 * alternative core implementation of elliptic curve arithmetic. Keep in mind
482 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100483 *
484 * This partially replaces one function. The header file from mbed TLS is still
485 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
486 * is still present and it is used for group structures not supported by the
487 * alternative.
488 *
Janos Follathc44ab972016-11-18 16:38:23 +0000489 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
490 * and implementing the following functions:
491 * unsigned char mbedtls_internal_ecp_grp_capable(
492 * const mbedtls_ecp_group *grp )
493 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Janos Follathd2af46f2018-12-07 10:39:00 +0000494 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000495 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
496 * replacement functions implement arithmetic for the given group and 0
497 * otherwise.
Janos Follathd2af46f2018-12-07 10:39:00 +0000498 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000499 * called before and after each point operation and provide an opportunity to
500 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100501 *
Janos Follathc44ab972016-11-18 16:38:23 +0000502 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000503 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000504 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
505 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
506 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000507 * implementation is used. The other functions and the definition of
508 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000509 * implementation of mbedtls_internal_ecp_double_jac and
510 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100511 *
512 * Uncomment a macro to enable alternate implementation of the corresponding
513 * function.
514 */
515/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000516//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100517/* Support for Weierstrass curves with Jacobi representation */
518//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
519//#define MBEDTLS_ECP_ADD_MIXED_ALT
520//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
521//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
522//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
523/* Support for curves with Montgomery arithmetic */
524//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
525//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
526//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
527
528/**
Simon Butcherab5df402016-06-11 02:31:21 +0100529 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100530 *
Simon Butcherab5df402016-06-11 02:31:21 +0100531 * Enables testing and use of mbed TLS without any configured entropy sources.
532 * This permits use of the library on platforms before an entropy source has
533 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
534 * MBEDTLS_ENTROPY_NV_SEED switches).
535 *
536 * WARNING! This switch MUST be disabled in production builds, and is suitable
537 * only for development.
538 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100539 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100540 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
541 *
Janos Follath53de7842016-06-08 15:29:18 +0100542 */
Simon Butcherab5df402016-06-11 02:31:21 +0100543//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100544
545/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200546 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200547 *
548 * Uncomment this macro to let mbed TLS use your own implementation of a
549 * hardware entropy collector.
550 *
551 * Your function must be called \c mbedtls_hardware_poll(), have the same
552 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
553 *
554 * Uncomment to use your own hardware entropy collector.
555 */
556//#define MBEDTLS_ENTROPY_HARDWARE_ALT
557
558/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000560 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100561 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000562 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100563 * Uncomment this macro to use precomputed AES tables stored in ROM.
564 * Comment this macro to generate AES tables in RAM at runtime.
565 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100566 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
567 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100568 * initialization time before the first AES operation can be performed.
569 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
570 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
571 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100572 *
573 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
574 *
Paul Bakker15566e42011-04-24 21:19:15 +0000575 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000577
578/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100579 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200580 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100581 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200582 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100583 * Uncommenting this macro omits 75% of the AES tables from
584 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
585 * by computing their values on the fly during operations
586 * (the tables are entry-wise rotations of one another).
587 *
588 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100589 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100590 * runtime. Specifically, one has to compare 4 accesses within
591 * different tables to 4 accesses with additional arithmetic
592 * operations within the same table. The performance gain/loss
593 * depends on the system and memory details.
594 *
595 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
596 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200597 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100598//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200599
600/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200602 *
603 * Use less ROM for the Camellia implementation (saves about 768 bytes).
604 *
605 * Uncomment this macro to use less memory for Camellia.
606 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200608
609/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200610 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200611 *
612 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200615
616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000618 *
619 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
620 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000622
623/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000625 *
626 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
627 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000629
630/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100631 * \def MBEDTLS_CIPHER_MODE_OFB
632 *
633 * Enable Output Feedback mode (OFB) for symmetric ciphers.
634 */
635#define MBEDTLS_CIPHER_MODE_OFB
636
637/**
638 * \def MBEDTLS_CIPHER_MODE_XTS
639 *
640 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
641 */
642#define MBEDTLS_CIPHER_MODE_XTS
643
644/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200645 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000646 *
647 * Enable NULL cipher.
648 * Warning: Only do so when you know what you are doing. This allows for
649 * encryption or channels without any security!
650 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +0100651 * This module is required to support the following ciphersuites in TLS:
652 * TLS_ECDH_ECDSA_WITH_NULL_SHA
653 * TLS_ECDH_RSA_WITH_NULL_SHA
654 * TLS_ECDHE_ECDSA_WITH_NULL_SHA
655 * TLS_ECDHE_RSA_WITH_NULL_SHA
656 * TLS_ECDHE_PSK_WITH_NULL_SHA384
657 * TLS_ECDHE_PSK_WITH_NULL_SHA256
658 * TLS_ECDHE_PSK_WITH_NULL_SHA
659 * TLS_DHE_PSK_WITH_NULL_SHA384
660 * TLS_DHE_PSK_WITH_NULL_SHA256
661 * TLS_DHE_PSK_WITH_NULL_SHA
662 * TLS_RSA_WITH_NULL_SHA256
663 * TLS_RSA_WITH_NULL_SHA
664 * TLS_RSA_WITH_NULL_MD5
665 * TLS_RSA_PSK_WITH_NULL_SHA384
666 * TLS_RSA_PSK_WITH_NULL_SHA256
667 * TLS_RSA_PSK_WITH_NULL_SHA
668 * TLS_PSK_WITH_NULL_SHA384
669 * TLS_PSK_WITH_NULL_SHA256
670 * TLS_PSK_WITH_NULL_SHA
Paul Bakkerfab5c822012-02-06 16:45:10 +0000671 *
Jaeden Amero1c66e482018-11-02 18:15:18 +0000672 * Uncomment this macro to enable the NULL cipher
Paul Bakkerfab5c822012-02-06 16:45:10 +0000673 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000675
676/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100677 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200678 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100679 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
680 * specific padding modes in the cipher layer with cipher modes that support
681 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200682 *
683 * If you disable all padding modes, only full blocks can be used with CBC.
684 *
685 * Enable padding modes in the cipher layer.
686 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#define MBEDTLS_CIPHER_PADDING_PKCS7
688#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
689#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
690#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200691
Gilles Peskine1540e5b2019-10-03 14:21:14 +0200692/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
693 *
694 * Uncomment this macro to use a 128-bit key in the CTR_DRBG module.
695 * By default, CTR_DRBG uses a 256-bit key.
696 */
697//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
698
Paul Bakker48e93c82013-08-14 12:21:18 +0200699/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100700 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200701 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100702 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
703 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200704 *
705 * Comment macros to disable the curve and functions for it
706 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200707#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
708#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
709#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
710#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
711#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
712#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
713#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
714#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
715#define MBEDTLS_ECP_DP_BP256R1_ENABLED
716#define MBEDTLS_ECP_DP_BP384R1_ENABLED
717#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200718#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000719#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200720
721/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200722 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200723 *
724 * Enable specific 'modulo p' routines for each NIST prime.
725 * Depending on the prime and architecture, makes operations 4 to 8 times
726 * faster on the corresponding curve.
727 *
728 * Comment this macro to disable NIST curves optimisation.
729 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200730#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200731
732/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200733 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100734 *
735 * Enable "non-blocking" ECC operations that can return early and be resumed.
736 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200737 * This allows various functions to pause by returning
Jaeden Amerode0a41b2018-11-02 18:40:14 +0000738 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in Mbed TLS's SSL module,
739 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in order
740 * to further progress and eventually complete their operation. This is
741 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum number
742 * of ECC operations a function may perform before pausing; see
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200743 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100744 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200745 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200746 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100747 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200748 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200749 *
Ron Eldor19779c42018-11-05 16:58:13 +0200750 * \note This option only works with the default software implementation of
751 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100752 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
753 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100754 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200755//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100756
757/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100758 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
759 *
760 * Use a backward compatible ECDH context.
761 *
762 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
763 * defined in `ecdh.h`). For most applications, the choice of format makes
764 * no difference, since all library functions can work with either format,
765 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
766
767 * The new format used when this option is disabled is smaller
768 * (56 bytes on a 32-bit platform). In future versions of the library, it
769 * will support alternative implementations of ECDH operations.
770 * The new format is incompatible with applications that access
771 * context fields directly and with restartable ECP operations.
772 *
773 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
774 * want to access ECDH context fields directly. Otherwise you should
775 * comment out this macro definition.
776 *
777 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
778 *
779 * \note This configuration option is experimental. Future versions of the
780 * library may modify the way the ECDH context layout is configured
781 * and may modify the layout of the new context type.
782 */
783#define MBEDTLS_ECDH_LEGACY_CONTEXT
784
785/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100787 *
788 * Enable deterministic ECDSA (RFC 6979).
789 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
790 * may result in a compromise of the long-term signing key. This is avoided by
791 * the deterministic variant.
792 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200793 * Requires: MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100794 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100795 * Comment this macro to disable deterministic ECDSA.
796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100798
799/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100801 *
802 * Enhance support for reading EC keys using variants of SEC1 not allowed by
803 * RFC 5915 and RFC 5480.
804 *
805 * Currently this means parsing the SpecifiedECDomain choice of EC
806 * parameters (only known groups are supported, not arbitrary domains, to
807 * avoid validation issues).
808 *
809 * Disable if you only need to support RFC 5915 + 5480 key formats.
810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100812
813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100815 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200816 * Enable a dummy error function to make use of mbedtls_strerror() in
817 * third party libraries easier when MBEDTLS_ERROR_C is disabled
818 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200819 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
821 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100822 *
823 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100827
828/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200829 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000830 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200831 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200832 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000834 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200835#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000836
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000837/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000839 *
840 * Enable functions that use the filesystem.
841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000843
844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000846 *
847 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000849 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700850 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000851 * application.
852 *
853 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000854 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200855//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000856
857/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000859 *
860 * Do not use built-in platform entropy functions.
861 * This is useful if your platform does not support
862 * standards like the /dev/urandom or Windows CryptoAPI.
863 *
864 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +0000865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200866//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000867
868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200869 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +0100870 *
871 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
872 * default SHA-512 based one (if both are available).
873 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +0100875 *
876 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
877 * if you have performance concerns.
878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879 * This option is only useful if both MBEDTLS_SHA256_C and
880 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +0100881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +0100883
884/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100885 * \def MBEDTLS_ENTROPY_NV_SEED
886 *
887 * Enable the non-volatile (NV) seed file-based entropy source.
888 * (Also enables the NV seed read/write functions in the platform layer)
889 *
890 * This is crucial (if not required) on systems that do not have a
891 * cryptographic entropy source (in hardware or kernel) available.
892 *
893 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
894 *
Paul Bakker71a597a2016-06-07 10:59:03 +0100895 * \note The read/write functions that are used by the entropy source are
896 * determined in the platform layer, and can be modified at runtime and/or
897 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
898 *
899 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100900 * with regular fopen(), please make sure you make a seedfile with the
901 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
902 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +0100903 * and written to or you will get an entropy source error! The default
904 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
905 * bytes from the file.
906 *
907 * \note The entropy collector will write to the seed file before entropy is
908 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100909 */
910//#define MBEDTLS_ENTROPY_NV_SEED
911
Gilles Peskine69d7c8b2019-02-19 14:00:31 +0100912/* MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
913 *
914 * In PSA key storage, encode the owner of the key.
915 *
916 * This is only meaningful when building the library as part of a
917 * multi-client service. When you activate this option, you must provide
918 * an implementation of the type psa_key_owner_id_t and a translation
919 * from psa_key_file_id_t to file name in all the storage backends that
920 * you wish to support.
921 *
922 * Note that this option is meant for internal use only and may be removed
923 * without notice.
924 */
925//#define MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
926
Netanel Gonen212a7932018-11-19 12:19:19 +0200927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +0200929 *
930 * Enable debugging of buffer allocator memory issues. Automatically prints
931 * (to stderr) all (fatal) messages on memory allocation issues. Enables
932 * function for 'debug output' of allocated memory.
933 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +0200935 *
936 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +0200937 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +0200939
940/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200941 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +0200942 *
943 * Include backtrace information with each allocated block.
944 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +0200946 * GLIBC-compatible backtrace() an backtrace_symbols() support
947 *
948 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +0200949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +0200951
952/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +0200954 *
955 * Support external private RSA keys (eg from a HSM) in the PK layer.
956 *
957 * Comment this macro to disable support for external private RSA keys.
958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +0200960
961/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200962 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +0200963 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200964 * Enable support for PKCS#1 v1.5 encoding.
965 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +0200967 *
Paul Bakker48377d92013-08-30 12:06:24 +0200968 * This enables support for PKCS#1 v1.5 operations.
969 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +0200971
972/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200973 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +0000974 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200975 * Enable support for PKCS#1 v2.1 encoding.
976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200977 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +0000978 *
Paul Bakker9dcc3222011-03-08 14:16:06 +0000979 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200981#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +0000982
983/**
Jaeden Amero67a93512018-07-11 16:07:40 +0100984 * \def MBEDTLS_PSA_CRYPTO_SPM
985 *
986 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
987 * Partition Manager) integration which separates the code into two parts: a
988 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
989 * Environment).
990 *
991 * Module: library/psa_crypto.c
992 * Requires: MBEDTLS_PSA_CRYPTO_C
993 *
994 */
995//#define MBEDTLS_PSA_CRYPTO_SPM
996
997/**
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100998 * \def MBEDTLS_PSA_INJECT_ENTROPY
999 *
1000 * Enable support for entropy injection at first boot. This feature is
1001 * required on systems that do not have a built-in entropy source (TRNG).
1002 * This feature is currently not supported on systems that have a built-in
1003 * entropy source.
1004 *
1005 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
1006 *
1007 */
1008//#define MBEDTLS_PSA_INJECT_ENTROPY
1009
1010/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001011 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +00001012 *
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001013 * Do not use the Chinese Remainder Theorem
1014 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +00001015 *
1016 * Uncomment this macro to disable the use of CRT in RSA.
1017 *
Paul Bakker0216cc12011-03-26 13:40:23 +00001018 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001019//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +00001020
1021/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001022 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +00001023 *
1024 * Enable the checkup functions (*_self_test).
1025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001026#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +00001027
1028/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +02001029 * \def MBEDTLS_SHA256_SMALLER
1030 *
1031 * Enable an implementation of SHA-256 that has lower ROM footprint but also
1032 * lower performance.
1033 *
1034 * The default implementation is meant to be a reasonnable compromise between
1035 * performance and size. This version optimizes more aggressively for size at
1036 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1037 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1038 * 30%.
1039 *
1040 * Uncomment to enable the smaller implementation of SHA256.
1041 */
1042//#define MBEDTLS_SHA256_SMALLER
1043
1044/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001045 * \def MBEDTLS_SHA512_SMALLER
1046 *
1047 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1048 * lower performance.
1049 *
1050 * Uncomment to enable the smaller implementation of SHA512.
1051 */
1052//#define MBEDTLS_SHA512_SMALLER
1053
1054/**
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001055 * \def MBEDTLS_SHA512_NO_SHA384
1056 *
1057 * Disable the SHA-384 option of the SHA-512 module. Use this to save some
1058 * code size on devices that don't use SHA-384.
1059 *
Manuel Pégourié-Gonnard1e6fb012020-01-07 11:00:34 +01001060 * Requires: MBEDTLS_SHA512_C
1061 *
Manuel Pégourié-Gonnardad6cb112019-07-17 14:58:03 +02001062 * Uncomment to disable SHA-384
1063 */
1064//#define MBEDTLS_SHA512_NO_SHA384
1065
1066/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001067 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001068 *
1069 * Provide your own alternate threading implementation.
1070 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001072 *
1073 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001074 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001076
1077/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001078 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001079 *
1080 * Enable the pthread wrapper layer for the threading layer.
1081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001082 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001083 *
1084 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001087
1088/**
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001089 * \def MBEDTLS_USE_PSA_CRYPTO
1090 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001091 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1092 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001093 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001094 * \note Development of this option is currently in progress, and parts of Mbed
1095 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001096 * will still continue to work as usual, so enabling this option should not
1097 * break backwards compatibility.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001098 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001099 * \warning Support for PSA is still an experimental feature.
1100 * Any public API that depends on this option may change
1101 * at any time until this warning is removed.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001102 *
1103 * \warning This option enables new Mbed TLS APIs that are dependent on the
1104 * PSA Crypto API, so can't come with the same stability guarantees as the
1105 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001106 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001107 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker56a78dd2018-11-19 09:46:26 +00001108 *
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001109 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001110 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001111 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001112 */
1113//#define MBEDTLS_USE_PSA_CRYPTO
1114
1115/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001116 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001117 *
1118 * Allow run-time checking of compile-time enabled features. Thus allowing users
1119 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001121 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001123 *
1124 * Comment this to disable run-time checking and save ROM space
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001127
Gilles Peskine252e3912020-02-26 18:33:58 +01001128/**
1129 * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
1130 *
1131 * If set, the X509 parser will not break-off when parsing an X509 certificate
1132 * and encountering an extension in a v1 or v2 certificate.
1133 *
1134 * Uncomment to prevent an error.
1135 */
1136//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3
1137
1138/**
1139 * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
1140 *
1141 * If set, the X509 parser will not break-off when parsing an X509 certificate
1142 * and encountering an unknown critical extension.
1143 *
1144 * \warning Depending on your PKI use, enabling this can be a security risk!
1145 *
1146 * Uncomment to prevent an error.
1147 */
1148//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION
1149
1150/**
1151 * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1152 *
1153 * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()`
1154 * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure
1155 * the set of trusted certificates through a callback instead of a linked
1156 * list.
1157 *
1158 * This is useful for example in environments where a large number of trusted
1159 * certificates is present and storing them in a linked list isn't efficient
1160 * enough, or when the set of trusted certificates changes frequently.
1161 *
1162 * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and
1163 * `mbedtls_ssl_conf_ca_cb()` for more information.
1164 *
1165 * Uncomment to enable trusted certificate callbacks.
1166 */
1167//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
1168
1169/**
1170 * \def MBEDTLS_X509_CHECK_KEY_USAGE
1171 *
1172 * Enable verification of the keyUsage extension (CA and leaf certificates).
1173 *
1174 * Disabling this avoids problems with mis-issued and/or misused
1175 * (intermediate) CA and leaf certificates.
1176 *
1177 * \warning Depending on your PKI use, disabling this can be a security risk!
1178 *
1179 * Comment to skip keyUsage checking for both CA and leaf certificates.
1180 */
1181#define MBEDTLS_X509_CHECK_KEY_USAGE
1182
1183/**
1184 * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
1185 *
1186 * Enable verification of the extendedKeyUsage extension (leaf certificates).
1187 *
1188 * Disabling this avoids problems with mis-issued and/or misused certificates.
1189 *
1190 * \warning Depending on your PKI use, disabling this can be a security risk!
1191 *
1192 * Comment to skip extendedKeyUsage checking for certificates.
1193 */
1194#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE
1195
1196/**
1197 * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT
1198 *
1199 * Enable parsing and verification of X.509 certificates, CRLs and CSRS
1200 * signed with RSASSA-PSS (aka PKCS#1 v2.1).
1201 *
1202 * Comment this macro to disallow using RSASSA-PSS in certificates.
1203 */
1204#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001205/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001206
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001207/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001208 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001209 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001210 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001211 * \{
1212 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001213
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001214/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001215 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001216 *
1217 * Enable AES-NI support on x86-64.
1218 *
1219 * Module: library/aesni.c
1220 * Caller: library/aes.c
1221 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001222 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001223 *
1224 * This modules adds support for the AES-NI instructions on x86-64
1225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001227
1228/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001230 *
1231 * Enable the AES block cipher.
1232 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001233 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001234 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001235 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001236 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001237 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001238 * This module is required to support the following ciphersuites in TLS:
1239 * TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
1240 * TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
1241 * TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
1242 * TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
1243 * TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
1244 * TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
1245 * TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
1246 * TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
1247 * TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
1248 * TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
1249 * TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
1250 * TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
1251 * TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
1252 * TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1253 * TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1254 * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1255 * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1256 * TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1257 * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1258 * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1259 * TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1260 * TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1261 * TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1262 * TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1263 * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1264 * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1265 * TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1266 * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1267 * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1268 * TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1269 * TLS_DHE_PSK_WITH_AES_256_GCM_SHA384
1270 * TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384
1271 * TLS_DHE_PSK_WITH_AES_256_CBC_SHA384
1272 * TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA
1273 * TLS_DHE_PSK_WITH_AES_256_CBC_SHA
1274 * TLS_DHE_PSK_WITH_AES_128_GCM_SHA256
1275 * TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256
1276 * TLS_DHE_PSK_WITH_AES_128_CBC_SHA256
1277 * TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA
1278 * TLS_DHE_PSK_WITH_AES_128_CBC_SHA
1279 * TLS_RSA_WITH_AES_256_GCM_SHA384
1280 * TLS_RSA_WITH_AES_256_CBC_SHA256
1281 * TLS_RSA_WITH_AES_256_CBC_SHA
1282 * TLS_RSA_WITH_AES_128_GCM_SHA256
1283 * TLS_RSA_WITH_AES_128_CBC_SHA256
1284 * TLS_RSA_WITH_AES_128_CBC_SHA
1285 * TLS_RSA_PSK_WITH_AES_256_GCM_SHA384
1286 * TLS_RSA_PSK_WITH_AES_256_CBC_SHA384
1287 * TLS_RSA_PSK_WITH_AES_256_CBC_SHA
1288 * TLS_RSA_PSK_WITH_AES_128_GCM_SHA256
1289 * TLS_RSA_PSK_WITH_AES_128_CBC_SHA256
1290 * TLS_RSA_PSK_WITH_AES_128_CBC_SHA
1291 * TLS_PSK_WITH_AES_256_GCM_SHA384
1292 * TLS_PSK_WITH_AES_256_CBC_SHA384
1293 * TLS_PSK_WITH_AES_256_CBC_SHA
1294 * TLS_PSK_WITH_AES_128_GCM_SHA256
1295 * TLS_PSK_WITH_AES_128_CBC_SHA256
1296 * TLS_PSK_WITH_AES_128_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01001297 *
Paul Bakkercff68422013-09-15 20:43:33 +02001298 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00001299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001301
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001302/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001304 *
1305 * Enable the ARCFOUR stream cipher.
1306 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001308 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001309 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001310 * This module is required to support the following ciphersuites in TLS:
1311 * TLS_ECDH_ECDSA_WITH_RC4_128_SHA
1312 * TLS_ECDH_RSA_WITH_RC4_128_SHA
1313 * TLS_ECDHE_ECDSA_WITH_RC4_128_SHA
1314 * TLS_ECDHE_RSA_WITH_RC4_128_SHA
1315 * TLS_ECDHE_PSK_WITH_RC4_128_SHA
1316 * TLS_DHE_PSK_WITH_RC4_128_SHA
1317 * TLS_RSA_WITH_RC4_128_SHA
1318 * TLS_RSA_WITH_RC4_128_MD5
1319 * TLS_RSA_PSK_WITH_RC4_128_SHA
1320 * TLS_PSK_WITH_RC4_128_SHA
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001321 *
1322 * \warning ARC4 is considered a weak cipher and its use constitutes a
1323 * security risk. If possible, we recommend avoidng dependencies on
1324 * it, and considering stronger ciphers instead.
1325 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001328
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001329/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001330 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001331 *
1332 * Enable the generic ASN1 parser.
1333 *
1334 * Module: library/asn1.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001335 * Caller: library/x509.c
1336 * library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001337 * library/pkcs12.c
1338 * library/pkcs5.c
1339 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00001340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001342
1343/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001345 *
1346 * Enable the generic ASN1 writer.
1347 *
1348 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001349 * Caller: library/ecdsa.c
1350 * library/pkwrite.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001351 * library/x509_create.c
1352 * library/x509write_crt.c
1353 * library/x509write_csr.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001354 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001355#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001356
1357/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001359 *
1360 * Enable the Base64 module.
1361 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001362 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00001363 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 *
Paul Bakker5690efc2011-05-26 13:16:06 +00001365 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00001366 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001367#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001368
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001369/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001370 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001371 *
Paul Bakker9a736322012-11-14 12:39:52 +00001372 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001373 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001374 * Module: library/bignum.c
1375 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001376 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02001377 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001378 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01001379 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001380 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02001381 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00001382 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001383#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001384
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00001387 *
1388 * Enable the Blowfish block cipher.
1389 *
1390 * Module: library/blowfish.c
1391 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00001393
1394/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001396 *
1397 * Enable the Camellia block cipher.
1398 *
Paul Bakker38119b12009-01-10 23:31:23 +00001399 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001400 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00001401 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001402 * This module is required to support the following ciphersuites in TLS:
1403 * TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1404 * TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1405 * TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256
1406 * TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384
1407 * TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1408 * TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1409 * TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256
1410 * TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384
1411 * TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384
1412 * TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1413 * TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384
1414 * TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384
1415 * TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384
1416 * TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256
1417 * TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA
1418 * TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256
1419 * TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1420 * TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256
1421 * TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256
1422 * TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1423 * TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256
1424 * TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA
1425 * TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384
1426 * TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1427 * TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384
1428 * TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256
1429 * TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1430 * TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256
1431 * TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384
1432 * TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256
1433 * TLS_RSA_WITH_CAMELLIA_256_CBC_SHA
1434 * TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256
1435 * TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256
1436 * TLS_RSA_WITH_CAMELLIA_128_CBC_SHA
1437 * TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384
1438 * TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384
1439 * TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256
1440 * TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256
1441 * TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384
1442 * TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384
1443 * TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256
1444 * TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256
Paul Bakker38119b12009-01-10 23:31:23 +00001445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001446#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00001447
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001448/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001449 * \def MBEDTLS_ARIA_C
1450 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01001451 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001452 *
1453 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01001454 * Caller: library/cipher.c
1455 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001456 * This module is required to support the following ciphersuites in TLS:
1457 * TLS_RSA_WITH_ARIA_128_CBC_SHA256
1458 * TLS_RSA_WITH_ARIA_256_CBC_SHA384
1459 * TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256
1460 * TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384
1461 * TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256
1462 * TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384
1463 * TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256
1464 * TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384
1465 * TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256
1466 * TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384
1467 * TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256
1468 * TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384
1469 * TLS_RSA_WITH_ARIA_128_GCM_SHA256
1470 * TLS_RSA_WITH_ARIA_256_GCM_SHA384
1471 * TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256
1472 * TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384
1473 * TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256
1474 * TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384
1475 * TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256
1476 * TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384
1477 * TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256
1478 * TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384
1479 * TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256
1480 * TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384
1481 * TLS_PSK_WITH_ARIA_128_CBC_SHA256
1482 * TLS_PSK_WITH_ARIA_256_CBC_SHA384
1483 * TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256
1484 * TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384
1485 * TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256
1486 * TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384
1487 * TLS_PSK_WITH_ARIA_128_GCM_SHA256
1488 * TLS_PSK_WITH_ARIA_256_GCM_SHA384
1489 * TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256
1490 * TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384
1491 * TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256
1492 * TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384
1493 * TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256
1494 * TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001495 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01001496//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001497
1498/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001500 *
1501 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
1502 *
1503 * Module: library/ccm.c
1504 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001506 *
Jaeden Amero1c66e482018-11-02 18:15:18 +00001507 * This module is required to support AES-CCM ciphersuites in TLS.
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001508 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001509#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001510
1511/**
Gilles Peskine252e3912020-02-26 18:33:58 +01001512 * \def MBEDTLS_CERTS_C
1513 *
1514 * Enable the test certificates.
1515 *
1516 * Module: library/certs.c
1517 * Caller:
1518 *
1519 * This module is used for testing (ssl_client/server).
1520 */
1521#define MBEDTLS_CERTS_C
1522
1523/**
Daniel King34b822c2016-05-15 17:28:08 -03001524 * \def MBEDTLS_CHACHA20_C
1525 *
1526 * Enable the ChaCha20 stream cipher.
1527 *
1528 * Module: library/chacha20.c
1529 */
1530#define MBEDTLS_CHACHA20_C
1531
1532/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02001533 * \def MBEDTLS_CHACHAPOLY_C
1534 *
1535 * Enable the ChaCha20-Poly1305 AEAD algorithm.
1536 *
1537 * Module: library/chachapoly.c
1538 *
1539 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
1540 */
1541#define MBEDTLS_CHACHAPOLY_C
1542
1543/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001544 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001545 *
1546 * Enable the generic cipher layer.
1547 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00001548 * Module: library/cipher.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00001549 *
1550 * Uncomment to enable generic cipher wrappers.
1551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00001553
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001554/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001555 * \def MBEDTLS_CMAC_C
1556 *
Simon Butcher327398a2016-10-05 14:09:11 +01001557 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
1558 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001559 *
1560 * Module: library/cmac.c
1561 *
Simon Butcher69283e52016-10-06 12:49:58 +01001562 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001563 *
1564 */
Gilles Peskinee59236f2018-01-27 23:32:46 +01001565#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001566
1567/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001569 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03001570 * Enable the CTR_DRBG AES-based random generator.
1571 * The CTR_DRBG generator uses AES-256 by default.
Gilles Peskine1540e5b2019-10-03 14:21:14 +02001572 * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001573 *
Gilles Peskine7e279362019-10-03 14:21:39 +02001574 * \note To achieve a 256-bit security strength with CTR_DRBG,
1575 * you must use AES-256 *and* use sufficient entropy.
1576 * See ctr_drbg.h for more details.
1577 *
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001578 * Module: library/ctr_drbg.c
1579 * Caller:
1580 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001581 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001582 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03001583 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001585#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001586
1587/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001589 *
1590 * Enable the DES block cipher.
1591 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001592 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01001593 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001594 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001595 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001596 * This module is required to support the following ciphersuites in TLS:
1597 * TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
1598 * TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
1599 * TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
1600 * TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1601 * TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
1602 * TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA
1603 * TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA
1604 * TLS_RSA_WITH_3DES_EDE_CBC_SHA
1605 * TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA
1606 * TLS_PSK_WITH_3DES_EDE_CBC_SHA
Paul Bakker6deb37e2013-02-19 13:17:08 +01001607 *
Paul Bakkercff68422013-09-15 20:43:33 +02001608 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001609 *
1610 * \warning DES is considered a weak cipher and its use constitutes a
1611 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00001612 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001613#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001614
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001615/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001616 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001617 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001618 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001619 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001620 * Module: library/dhm.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001621 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001622 * This module is used by the following key exchanges:
1623 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01001624 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001625 * \warning Using DHE constitutes a security risk as it
1626 * is not possible to validate custom DH parameters.
1627 * If possible, it is recommended users should consider
1628 * preferring other methods of key exchange.
1629 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001630 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001633
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001636 *
1637 * Enable the elliptic curve Diffie-Hellman library.
1638 *
1639 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01001640 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001641 * This module is used by the following key exchanges:
1642 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001643 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001647
1648/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001650 *
1651 * Enable the elliptic curve DSA library.
1652 *
1653 * Module: library/ecdsa.c
1654 * Caller:
1655 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001656 * This module is used by the following key exchanges:
1657 * ECDHE-ECDSA
1658 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001660 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001661#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001662
1663/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001664 * \def MBEDTLS_ECJPAKE_C
1665 *
1666 * Enable the elliptic curve J-PAKE library.
1667 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001668 * \warning This is currently experimental. EC J-PAKE support is based on the
1669 * Thread v1.0.0 specification; incompatible changes to the specification
1670 * might still happen. For this reason, this is disabled by default.
1671 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001672 * Module: library/ecjpake.c
1673 * Caller:
1674 *
1675 * This module is used by the following key exchanges:
1676 * ECJPAKE
1677 *
1678 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
1679 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001680//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001681
1682/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001683 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001684 *
1685 * Enable the elliptic curve over GF(p) library.
1686 *
1687 * Module: library/ecp.c
1688 * Caller: library/ecdh.c
1689 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001690 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001691 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001692 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001693 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001695
1696/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001697 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001698 *
1699 * Enable the platform-specific entropy code.
1700 *
1701 * Module: library/entropy.c
1702 * Caller:
1703 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001705 *
1706 * This module provides a generic entropy pool
1707 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001709
1710/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00001712 *
1713 * Enable error code to error string conversion.
1714 *
1715 * Module: library/error.c
1716 * Caller:
1717 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001718 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00001719 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001720#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00001721
1722/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00001724 *
Jaeden Amero7accf442019-04-10 18:13:57 +01001725 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00001726 *
1727 * Module: library/gcm.c
1728 *
Jaeden Amero651ae682019-04-10 18:19:16 +01001729 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00001730 *
Gilles Peskinedb7d5f02020-02-26 18:25:11 +01001731 * This module is required to support AES-GCM and CAMELLIA-GCM ciphersuites in
1732 * TLS.
Paul Bakker89e80c92012-03-20 13:50:09 +00001733 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001734#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00001735
1736/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001737 * \def MBEDTLS_HAVEGE_C
1738 *
1739 * Enable the HAVEGE random generator.
1740 *
1741 * Warning: the HAVEGE random generator is not suitable for virtualized
1742 * environments
1743 *
1744 * Warning: the HAVEGE random generator is dependent on timing and specific
1745 * processor traits. It is therefore not advised to use HAVEGE as
1746 * your applications primary random generator or primary entropy pool
1747 * input. As a secondary input to your entropy pool, it IS able add
1748 * the (limited) extra entropy it provides.
1749 *
1750 * Module: library/havege.c
1751 * Caller:
1752 *
1753 * Requires: MBEDTLS_TIMING_C
1754 *
1755 * Uncomment to enable the HAVEGE random generator.
1756 */
1757//#define MBEDTLS_HAVEGE_C
1758
1759/**
Thomas Fossati656864b2016-07-17 08:51:22 +01001760 * \def MBEDTLS_HKDF_C
1761 *
1762 * Enable the HKDF algorithm (RFC 5869).
1763 *
1764 * Module: library/hkdf.c
1765 * Caller:
1766 *
1767 * Requires: MBEDTLS_MD_C
1768 *
1769 * This module adds support for the Hashed Message Authentication Code
1770 * (HMAC)-based key derivation function (HKDF).
1771 */
1772#define MBEDTLS_HKDF_C
1773
1774/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001776 *
1777 * Enable the HMAC_DRBG random generator.
1778 *
1779 * Module: library/hmac_drbg.c
1780 * Caller:
1781 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001782 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001783 *
1784 * Uncomment to enable the HMAC_DRBG random number geerator.
1785 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001786#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001787
1788/**
Ron Eldor466a57f2018-05-03 16:54:28 +03001789 * \def MBEDTLS_NIST_KW_C
1790 *
1791 * Enable the Key Wrapping mode for 128-bit block ciphers,
1792 * as defined in NIST SP 800-38F. Only KW and KWP modes
1793 * are supported. At the moment, only AES is approved by NIST.
1794 *
1795 * Module: library/nist_kw.c
1796 *
1797 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
1798 */
1799//#define MBEDTLS_NIST_KW_C
1800
1801/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001803 *
1804 * Enable the generic message digest layer.
1805 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001806 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00001807 * Caller:
1808 *
1809 * Uncomment to enable generic message digest wrappers.
1810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001811#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00001812
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001813/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001814 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001815 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001816 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001817 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001818 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001819 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00001820 *
1821 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001822 *
1823 * \warning MD2 is considered a weak message digest and its use constitutes a
1824 * security risk. If possible, we recommend avoiding dependencies on
1825 * it, and considering stronger message digests instead.
1826 *
Paul Bakker6506aff2009-07-28 20:52:02 +00001827 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001828//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001829
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001830/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001831 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001832 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001833 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001834 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001835 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001836 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00001837 *
1838 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001839 *
1840 * \warning MD4 is considered a weak message digest and its use constitutes a
1841 * security risk. If possible, we recommend avoiding dependencies on
1842 * it, and considering stronger message digests instead.
1843 *
Paul Bakker6506aff2009-07-28 20:52:02 +00001844 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001845//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001846
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001847/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001848 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001849 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001850 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001851 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001852 * Module: library/md5.c
1853 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001854 * library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001855 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001856 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
1857 * depending on the handshake parameters. Further, it is used for checking
1858 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
1859 * encrypted keys.
1860 *
1861 * \warning MD5 is considered a weak message digest and its use constitutes a
1862 * security risk. If possible, we recommend avoiding dependencies on
1863 * it, and considering stronger message digests instead.
1864 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001865 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001867
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001868/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001870 *
1871 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02001872 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001873 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02001874 *
1875 * Module: library/memory_buffer_alloc.c
1876 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * Requires: MBEDTLS_PLATFORM_C
1878 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02001879 *
1880 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02001881 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001883
1884/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001885 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02001886 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001887 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02001888 *
1889 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001890 * Caller: library/asn1write.c
1891 * library/pkcs5.c
1892 * library/pkparse.c
1893 * library/pkwrite.c
1894 * library/rsa.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001895 * library/x509.c
1896 * library/x509_create.c
1897 * library/x509_crl.c
1898 * library/x509_crt.c
1899 * library/x509_csr.c
1900 * library/x509write_crt.c
1901 * library/x509write_csr.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02001902 *
1903 * This modules translates between OIDs and internal values.
1904 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001905#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02001906
1907/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001908 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001909 *
1910 * Enable VIA Padlock support on x86.
1911 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001912 * Module: library/padlock.c
1913 * Caller: library/aes.c
1914 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001916 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001917 * This modules adds support for the VIA PadLock on x86.
1918 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001919#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001920
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001921/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001922 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00001923 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001924 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00001925 *
1926 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001927 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02001928 * library/pkparse.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001929 * library/x509_crl.c
1930 * library/x509_crt.c
1931 * library/x509_csr.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001932 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001934 *
Paul Bakkercff68422013-09-15 20:43:33 +02001935 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00001936 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001937#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02001938
1939/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001940 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02001941 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001942 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02001943 *
1944 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001945 * Caller: library/pkwrite.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001946 * library/x509write_crt.c
1947 * library/x509write_csr.c
Paul Bakkercff68422013-09-15 20:43:33 +02001948 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02001950 *
1951 * This modules adds support for encoding / writing PEM files.
1952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001953#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00001954
1955/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001957 *
1958 * Enable the generic public (asymetric) key layer.
1959 *
1960 * Module: library/pk.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001961 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02001963 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001964 * Uncomment to enable generic public key wrappers.
1965 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001967
1968/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001970 *
1971 * Enable the generic public (asymetric) key parser.
1972 *
1973 * Module: library/pkparse.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001974 * Caller: library/x509_crt.c
1975 * library/x509_csr.c
Paul Bakker4606c732013-09-15 17:04:23 +02001976 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001977 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02001978 *
1979 * Uncomment to enable generic public key parse functions.
1980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001982
1983/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001985 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02001986 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02001987 *
1988 * Module: library/pkwrite.c
Gilles Peskine252e3912020-02-26 18:33:58 +01001989 * Caller: library/x509write.c
Paul Bakker4606c732013-09-15 17:04:23 +02001990 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02001992 *
1993 * Uncomment to enable generic public key write functions.
1994 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001996
1997/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001999 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002000 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002001 *
2002 * Module: library/pkcs5.c
2003 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002005 *
2006 * This module adds support for the PKCS#5 functions.
2007 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002008#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02002009
2010/**
Gilles Peskine252e3912020-02-26 18:33:58 +01002011 * \def MBEDTLS_PKCS11_C
2012 *
2013 * Enable wrapper for PKCS#11 smartcard support.
2014 *
2015 * Module: library/pkcs11.c
2016 * Caller: library/pk.c
2017 *
2018 * Requires: MBEDTLS_PK_C
2019 *
2020 * This module enables SSL/TLS PKCS #11 smartcard support.
2021 * Requires the presence of the PKCS#11 helper library (libpkcs11-helper)
2022 */
2023//#define MBEDTLS_PKCS11_C
2024
2025/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002026 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002027 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02002028 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002029 * Adds algorithms for parsing PKCS#8 encrypted private keys
2030 *
2031 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002032 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
2035 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002036 *
2037 * This module enables PKCS#12 functions.
2038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002039#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02002040
2041/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002043 *
2044 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002045 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01002046 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002047 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
2048 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00002049 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01002050 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02002051 * \note This abstraction layer must be enabled on Windows (including MSYS2)
2052 * as other module rely on it for a fixed snprintf implementation.
2053 *
Paul Bakker747a83a2014-02-01 22:50:07 +01002054 * Module: library/platform.c
2055 * Caller: Most other .c files
2056 *
2057 * This module enables abstraction of common (libc) functions.
2058 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002059#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01002060
2061/**
Daniel Kingadc32c02016-05-16 18:25:45 -03002062 * \def MBEDTLS_POLY1305_C
2063 *
2064 * Enable the Poly1305 MAC algorithm.
2065 *
2066 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02002067 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03002068 */
2069#define MBEDTLS_POLY1305_C
2070
2071/**
Jaeden Ameroe852df82018-09-14 12:00:46 +01002072 * \def MBEDTLS_PSA_CRYPTO_C
Gilles Peskinee59236f2018-01-27 23:32:46 +01002073 *
2074 * Enable the Platform Security Architecture cryptography API.
2075 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01002076 * \warning The PSA Crypto API is still beta status. While you're welcome to
2077 * experiment using it, incompatible API changes are still possible, and some
2078 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01002079 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01002080 * Module: library/psa_crypto.c
2081 *
2082 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
2083 *
2084 */
2085#define MBEDTLS_PSA_CRYPTO_C
2086
2087/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02002088 * \def MBEDTLS_PSA_CRYPTO_SE_C
2089 *
2090 * Enable secure element support in the Platform Security Architecture
2091 * cryptography API.
2092 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02002093 * \warning This feature is not yet suitable for production. It is provided
2094 * for API evaluation and testing purposes only.
2095 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02002096 * Module: library/psa_crypto_se.c
2097 *
2098 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
2099 *
2100 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02002101//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02002102
2103/**
Darryl Greendb2b8db2018-06-15 13:06:04 +01002104 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
2105 *
2106 * Enable the Platform Security Architecture persistent key storage.
2107 *
2108 * Module: library/psa_crypto_storage.c
2109 *
Gilles Peskine088b77f2019-02-24 17:00:27 +01002110 * Requires: MBEDTLS_PSA_CRYPTO_C,
2111 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
2112 * the PSA ITS interface
Darryl Greendb2b8db2018-06-15 13:06:04 +01002113 */
2114#define MBEDTLS_PSA_CRYPTO_STORAGE_C
2115
2116/**
Gilles Peskine6194dc22018-11-16 22:24:15 +01002117 * \def MBEDTLS_PSA_ITS_FILE_C
2118 *
2119 * Enable the emulation of the Platform Security Architecture
2120 * Internal Trusted Storage (PSA ITS) over files.
2121 *
2122 * Module: library/psa_its_file.c
2123 *
2124 * Requires: MBEDTLS_FS_IO
2125 */
2126#define MBEDTLS_PSA_ITS_FILE_C
2127
2128/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002129 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002130 *
2131 * Enable the RIPEMD-160 hash algorithm.
2132 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002133 * Module: library/ripemd160.c
2134 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002135 *
2136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01002138
2139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002141 *
2142 * Enable the RSA public-key cryptosystem.
2143 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002144 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01002145 * library/rsa_internal.c
Gilles Peskine252e3912020-02-26 18:33:58 +01002146 * Caller: library/x509.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002147 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02002148 * This module is used by the following key exchanges:
2149 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00002150 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002152 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002153#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002154
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002155/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002156 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002157 *
2158 * Enable the SHA1 cryptographic hash algorithm.
2159 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002160 * Module: library/sha1.c
2161 * Caller: library/md.c
Gilles Peskine252e3912020-02-26 18:33:58 +01002162 * library/x509write_crt.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002163 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02002164 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
2165 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01002166 *
2167 * \warning SHA-1 is considered a weak message digest and its use constitutes
2168 * a security risk. If possible, we recommend avoiding dependencies
2169 * on it, and considering stronger message digests instead.
2170 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002171 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002172#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002173
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002174/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002176 *
2177 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
2178 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002179 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002180 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002181 * library/md.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002182 *
2183 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01002184 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00002185 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002187
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002188/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002189 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002190 *
2191 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
2192 *
Simon Butcher2cb47392016-11-04 12:23:11 +00002193 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02002194 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00002195 * library/md.c
Paul Bakker5121ce52009-01-03 21:22:43 +00002196 *
2197 * This module adds support for SHA-384 and SHA-512.
2198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002200
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002201/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002203 *
2204 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002205 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02002206 * contexts are not shared between threads. If you do intend to use contexts
2207 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002208 * conditions. See also our Knowledge Base article about threading:
2209 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02002210 *
2211 * Module: library/threading.c
2212 *
2213 * This allows different threading implementations (self-implemented or
2214 * provided).
2215 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002216 * You will have to enable either MBEDTLS_THREADING_ALT or
2217 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02002218 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002219 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02002220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002221//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02002222
2223/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02002224 * \def MBEDTLS_TIMING_C
2225 *
2226 * Enable the semi-portable timing interface.
2227 *
2228 * \note The provided implementation only works on POSIX/Unix (including Linux,
2229 * BSD and OS X) and Windows. On other platforms, you can either disable that
Jaeden Amero1c66e482018-11-02 18:15:18 +00002230 * module and provide your own implementations of the callbacks needed by Mbed
2231 * TLS's \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and
2232 * provide your own implementation of the whole module by setting
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02002233 * \c MBEDTLS_TIMING_ALT in the current file.
2234 *
2235 * \note See also our Knowledge Base article about porting to a new
2236 * environment:
2237 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
2238 *
2239 * Module: library/timing.c
2240 * Caller: library/havege.c
2241 *
2242 * This module is used by the HAVEGE random number generator.
2243 */
2244#define MBEDTLS_TIMING_C
2245
2246/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002247 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002248 *
2249 * Enable run-time version information.
2250 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00002251 * Module: library/version.c
2252 *
2253 * This module provides run-time version information.
2254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00002256
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002257/**
Gilles Peskine252e3912020-02-26 18:33:58 +01002258 * \def MBEDTLS_X509_USE_C
2259 *
2260 * Enable X.509 core for using certificates.
2261 *
2262 * Module: library/x509.c
2263 * Caller: library/x509_crl.c
2264 * library/x509_crt.c
2265 * library/x509_csr.c
2266 *
2267 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C,
2268 * MBEDTLS_PK_PARSE_C
2269 *
2270 * This module is required for the X.509 parsing modules.
2271 */
2272#define MBEDTLS_X509_USE_C
2273
2274/**
2275 * \def MBEDTLS_X509_CRT_PARSE_C
2276 *
2277 * Enable X.509 certificate parsing.
2278 *
2279 * Module: library/x509_crt.c
2280 * Caller: library/ssl_cli.c
2281 * library/ssl_srv.c
2282 * library/ssl_tls.c
2283 *
2284 * Requires: MBEDTLS_X509_USE_C
2285 *
2286 * This module is required for X.509 certificate parsing.
2287 */
2288#define MBEDTLS_X509_CRT_PARSE_C
2289
2290/**
2291 * \def MBEDTLS_X509_CRL_PARSE_C
2292 *
2293 * Enable X.509 CRL parsing.
2294 *
2295 * Module: library/x509_crl.c
2296 * Caller: library/x509_crt.c
2297 *
2298 * Requires: MBEDTLS_X509_USE_C
2299 *
2300 * This module is required for X.509 CRL parsing.
2301 */
2302#define MBEDTLS_X509_CRL_PARSE_C
2303
2304/**
2305 * \def MBEDTLS_X509_CSR_PARSE_C
2306 *
2307 * Enable X.509 Certificate Signing Request (CSR) parsing.
2308 *
2309 * Module: library/x509_csr.c
2310 * Caller: library/x509_crt_write.c
2311 *
2312 * Requires: MBEDTLS_X509_USE_C
2313 *
2314 * This module is used for reading X.509 certificate request.
2315 */
2316#define MBEDTLS_X509_CSR_PARSE_C
2317
2318/**
2319 * \def MBEDTLS_X509_CREATE_C
2320 *
2321 * Enable X.509 core for creating certificates.
2322 *
2323 * Module: library/x509_create.c
2324 *
2325 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C
2326 *
2327 * This module is the basis for creating X.509 certificates and CSRs.
2328 */
2329#define MBEDTLS_X509_CREATE_C
2330
2331/**
2332 * \def MBEDTLS_X509_CRT_WRITE_C
2333 *
2334 * Enable creating X.509 certificates.
2335 *
2336 * Module: library/x509_crt_write.c
2337 *
2338 * Requires: MBEDTLS_X509_CREATE_C
2339 *
2340 * This module is required for X.509 certificate creation.
2341 */
2342#define MBEDTLS_X509_CRT_WRITE_C
2343
2344/**
2345 * \def MBEDTLS_X509_CSR_WRITE_C
2346 *
2347 * Enable creating X.509 Certificate Signing Requests (CSR).
2348 *
2349 * Module: library/x509_csr_write.c
2350 *
2351 * Requires: MBEDTLS_X509_CREATE_C
2352 *
2353 * This module is required for X.509 certificate request writing.
2354 */
2355#define MBEDTLS_X509_CSR_WRITE_C
2356
2357/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00002359 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00002360 * Enable the XTEA block cipher.
2361 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00002362 * Module: library/xtea.c
2363 * Caller:
2364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002365#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01002366
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002367/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00002368
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002369/**
2370 * \name SECTION: Module configuration options
2371 *
2372 * This section allows for the setting of module specific sizes and
2373 * configuration options. The default values are already present in the
2374 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002375 *
Paul Bakker088c5c52014-04-25 11:11:10 +02002376 * Our advice is to enable options and change their values here
2377 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002378 *
2379 * Please check the respective header file for documentation on these
2380 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002381 * \{
2382 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002383
Paul Bakker088c5c52014-04-25 11:11:10 +02002384/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
2386//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002387
Paul Bakker088c5c52014-04-25 11:11:10 +02002388/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
2390//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
2391//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
2392//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
2393//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002394
Paul Bakker088c5c52014-04-25 11:11:10 +02002395/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
2397//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
2398//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
2399//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002400
Paul Bakker088c5c52014-04-25 11:11:10 +02002401/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
2403//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
2404//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01002405
Paul Bakker088c5c52014-04-25 11:11:10 +02002406/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
2408//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01002409//#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 +01002410
Paul Bakker088c5c52014-04-25 11:11:10 +02002411/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02002413
Paul Bakker088c5c52014-04-25 11:11:10 +02002414/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002415//#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 +02002416//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
2418//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01002419//#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 +02002420//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
2421//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01002422/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00002424//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
2425//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01002426//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
2427//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
2428//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02002429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
2431/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002432//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
2434//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01002435//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
2436//#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 +02002437//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
2438//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01002439/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002440//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02002441//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01002442//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
2443//#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 +02002444
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002445/**
2446 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002447 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002448 * (see the documentation of that option for context).
2449 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002450 * When you leave this undefined here, the library provides
2451 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
2452 * is defined, the default definition is `assert(cond)`,
2453 * otherwise the default definition calls a function
2454 * mbedtls_param_failed(). This function is declared in
2455 * `platform_util.h` for the benefit of the library, but
2456 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002457 *
2458 * When you define this here, this replaces the default
2459 * definition in platform_util.h (which no longer declares the
2460 * function mbedtls_param_failed()) and it is your responsibility
2461 * to make sure this macro expands to something suitable (in
2462 * particular, that all the necessary declarations are visible
2463 * from within the library - you can ensure that by providing
2464 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002465 * If you define this macro to call `assert`, also define
2466 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
2467 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002468 *
2469 * Note that you may define this macro to expand to nothing, in
2470 * which case you don't have to worry about declarations or
2471 * definitions. However, you will then be notified about invalid
2472 * parameters only in non-void functions, and void function will
2473 * just silently return early on invalid parameters, which
2474 * partially negates the benefits of enabling
2475 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
2476 *
2477 * \param cond The expression that should evaluate to true, but doesn't.
2478 */
2479//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
2480
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002481/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002482 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002483 * mbedtls_platform_zeroize(). This replaces the default implementation in
2484 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00002485 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002486 * mbedtls_platform_zeroize() is a widely used function across the library to
2487 * zero a block of memory. The implementation is expected to be secure in the
2488 * sense that it has been written to prevent the compiler from removing calls
2489 * to mbedtls_platform_zeroize() as part of redundant code elimination
2490 * optimizations. However, it is difficult to guarantee that calls to
2491 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
2492 * versions of the C language standards do not provide a secure implementation
2493 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
2494 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05002495 * example by using directives specific to their compiler, features from newer
2496 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002497 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002498 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002499//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002500
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002501/**
2502 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01002503 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002504 * platform_util.c.
2505 *
Hanno Becker921b76d2018-09-05 16:21:36 +01002506 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002507 * library will try to use safer implementations of this function, such as
2508 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01002509 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002510 * using the standard gmtime(). In this case, calls from the library to
2511 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01002512 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002513 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01002514 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
2515 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
2516 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002517 */
Hanno Becker6a739782018-09-05 15:06:19 +01002518//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002519
Christoph M. Wintersteigerc3cbdde2018-12-14 11:03:02 +00002520/**
Christoph M. Wintersteiger5833de72019-02-15 12:49:27 +00002521 * Enable the verified implementations of ECDH primitives from Project Everest
2522 * (currently only Curve25519). This feature changes the layout of ECDH
2523 * contexts and therefore is a compatibility break for applications that access
2524 * fields of a mbedtls_ecdh_context structure directly. See also
2525 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteigerde4fcf22018-10-25 12:41:04 +01002526 */
Christoph M. Wintersteiger78450a32019-01-17 12:17:54 +00002527//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteigerde4fcf22018-10-25 12:41:04 +01002528
2529/* \} name SECTION: Customisation configuration options */
2530
Simon Butcher3ad2efd2018-05-02 14:49:38 +01002531/* Target and application specific configurations
2532 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002533 * Allow user to override any previous default.
2534 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002535 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01002536#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002537#include MBEDTLS_USER_CONFIG_FILE
2538#endif
2539
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +01002540#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002541
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002542#endif /* MBEDTLS_CONFIG_H */