blob: 3c1430ce9d529b56c1eef6e0eafc664cde643c7b [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 *
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445//#define MBEDTLS_MD2_PROCESS_ALT
446//#define MBEDTLS_MD4_PROCESS_ALT
447//#define MBEDTLS_MD5_PROCESS_ALT
448//#define MBEDTLS_RIPEMD160_PROCESS_ALT
449//#define MBEDTLS_SHA1_PROCESS_ALT
450//#define MBEDTLS_SHA256_PROCESS_ALT
451//#define MBEDTLS_SHA512_PROCESS_ALT
Manuel Pégourié-Gonnard70a50102015-05-12 15:02:45 +0200452//#define MBEDTLS_DES_SETKEY_ALT
453//#define MBEDTLS_DES_CRYPT_ECB_ALT
454//#define MBEDTLS_DES3_CRYPT_ECB_ALT
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200455//#define MBEDTLS_AES_SETKEY_ENC_ALT
456//#define MBEDTLS_AES_SETKEY_DEC_ALT
457//#define MBEDTLS_AES_ENCRYPT_ALT
458//#define MBEDTLS_AES_DECRYPT_ALT
Ron Eldora84c1cb2017-10-10 19:04:27 +0300459//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
Ron Eldor3226d362017-10-12 14:17:48 +0300460//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
Ron Eldor314adb62017-10-10 18:28:25 +0300461//#define MBEDTLS_ECDSA_VERIFY_ALT
462//#define MBEDTLS_ECDSA_SIGN_ALT
463//#define MBEDTLS_ECDSA_GENKEY_ALT
Manuel Pégourié-Gonnard427b6722015-03-31 18:32:50 +0200464
465/**
Janos Follathc44ab972016-11-18 16:38:23 +0000466 * \def MBEDTLS_ECP_INTERNAL_ALT
467 *
468 * Expose a part of the internal interface of the Elliptic Curve Point module.
Janos Follathb0697532016-08-18 12:38:46 +0100469 *
470 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
Janos Follath372697b2016-10-28 16:53:11 +0100471 * alternative core implementation of elliptic curve arithmetic. Keep in mind
472 * that function prototypes should remain the same.
Janos Follathb0697532016-08-18 12:38:46 +0100473 *
474 * This partially replaces one function. The header file from mbed TLS is still
475 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
476 * is still present and it is used for group structures not supported by the
477 * alternative.
478 *
Janos Follathc44ab972016-11-18 16:38:23 +0000479 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
480 * and implementing the following functions:
481 * unsigned char mbedtls_internal_ecp_grp_capable(
482 * const mbedtls_ecp_group *grp )
483 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Janos Follathd2af46f2018-12-07 10:39:00 +0000484 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Janos Follathc44ab972016-11-18 16:38:23 +0000485 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
486 * replacement functions implement arithmetic for the given group and 0
487 * otherwise.
Janos Follathd2af46f2018-12-07 10:39:00 +0000488 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Janos Follathc44ab972016-11-18 16:38:23 +0000489 * called before and after each point operation and provide an opportunity to
490 * implement optimized set up and tear down instructions.
Janos Follathb0697532016-08-18 12:38:46 +0100491 *
Janos Follathc44ab972016-11-18 16:38:23 +0000492 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
Janos Follath4d9c69d2016-11-01 13:27:03 +0000493 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
Janos Follathc44ab972016-11-18 16:38:23 +0000494 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
495 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
496 * receives it as an argument). If the group is not supported then the original
Janos Follathee782bc2016-11-07 15:41:26 +0000497 * implementation is used. The other functions and the definition of
498 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
Janos Follathc44ab972016-11-18 16:38:23 +0000499 * implementation of mbedtls_internal_ecp_double_jac and
500 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
Janos Follathb0697532016-08-18 12:38:46 +0100501 *
502 * Uncomment a macro to enable alternate implementation of the corresponding
503 * function.
504 */
505/* Required for all the functions in this section */
Janos Follathc44ab972016-11-18 16:38:23 +0000506//#define MBEDTLS_ECP_INTERNAL_ALT
Janos Follathb0697532016-08-18 12:38:46 +0100507/* Support for Weierstrass curves with Jacobi representation */
508//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
509//#define MBEDTLS_ECP_ADD_MIXED_ALT
510//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
511//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
512//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
513/* Support for curves with Montgomery arithmetic */
514//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
515//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
516//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
517
518/**
Simon Butcherab5df402016-06-11 02:31:21 +0100519 * \def MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100520 *
Simon Butcherab5df402016-06-11 02:31:21 +0100521 * Enables testing and use of mbed TLS without any configured entropy sources.
522 * This permits use of the library on platforms before an entropy source has
523 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
524 * MBEDTLS_ENTROPY_NV_SEED switches).
525 *
526 * WARNING! This switch MUST be disabled in production builds, and is suitable
527 * only for development.
528 * Enabling the switch negates any security provided by the library.
Janos Follath53de7842016-06-08 15:29:18 +0100529 *
Janos Follathf93b8bc2016-06-09 13:54:15 +0100530 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
531 *
Janos Follath53de7842016-06-08 15:29:18 +0100532 */
Simon Butcherab5df402016-06-11 02:31:21 +0100533//#define MBEDTLS_TEST_NULL_ENTROPY
Janos Follath53de7842016-06-08 15:29:18 +0100534
535/**
Manuel Pégourié-Gonnard8ba88f02015-06-22 12:14:20 +0200536 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
Manuel Pégourié-Gonnard3f77dfb2015-06-19 10:06:21 +0200537 *
538 * Uncomment this macro to let mbed TLS use your own implementation of a
539 * hardware entropy collector.
540 *
541 * Your function must be called \c mbedtls_hardware_poll(), have the same
542 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
543 *
544 * Uncomment to use your own hardware entropy collector.
545 */
546//#define MBEDTLS_ENTROPY_HARDWARE_ALT
547
548/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200549 * \def MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000550 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100551 * Use precomputed AES tables stored in ROM.
Paul Bakker15566e42011-04-24 21:19:15 +0000552 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100553 * Uncomment this macro to use precomputed AES tables stored in ROM.
554 * Comment this macro to generate AES tables in RAM at runtime.
555 *
Hanno Becker4c1dc3c2018-03-27 16:52:03 +0100556 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
557 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
Hanno Becker6a92ce62018-03-28 11:42:05 +0100558 * initialization time before the first AES operation can be performed.
559 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
560 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
561 * performance if ROM access is slower than RAM access.
Hanno Becker177d3cf2017-06-07 15:52:48 +0100562 *
563 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
564 *
Paul Bakker15566e42011-04-24 21:19:15 +0000565 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566//#define MBEDTLS_AES_ROM_TABLES
Paul Bakker15566e42011-04-24 21:19:15 +0000567
568/**
Hanno Becker177d3cf2017-06-07 15:52:48 +0100569 * \def MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200570 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100571 * Use less ROM/RAM for AES tables.
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200572 *
Hanno Becker177d3cf2017-06-07 15:52:48 +0100573 * Uncommenting this macro omits 75% of the AES tables from
574 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
575 * by computing their values on the fly during operations
576 * (the tables are entry-wise rotations of one another).
577 *
578 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
Hanno Becker08a5c182017-06-19 16:33:58 +0100579 * by ~6kb but at the cost of more arithmetic operations during
Hanno Becker177d3cf2017-06-07 15:52:48 +0100580 * runtime. Specifically, one has to compare 4 accesses within
581 * different tables to 4 accesses with additional arithmetic
582 * operations within the same table. The performance gain/loss
583 * depends on the system and memory details.
584 *
585 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
586 *
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200587 */
Hanno Becker177d3cf2017-06-07 15:52:48 +0100588//#define MBEDTLS_AES_FEWER_TABLES
Jussi Kivilinna2fd1bb82015-11-12 16:38:31 +0200589
590/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200592 *
593 * Use less ROM for the Camellia implementation (saves about 768 bytes).
594 *
595 * Uncomment this macro to use less memory for Camellia.
596 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
Manuel Pégourié-Gonnard62edcc82015-04-03 16:28:19 +0200598
599/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600 * \def MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200601 *
602 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200604#define MBEDTLS_CIPHER_MODE_CBC
Manuel Pégourié-Gonnardf7dc3782013-09-13 14:10:44 +0200605
606/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200607 * \def MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000608 *
609 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200611#define MBEDTLS_CIPHER_MODE_CFB
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000612
613/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200614 * \def MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000615 *
616 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
617 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200618#define MBEDTLS_CIPHER_MODE_CTR
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000619
620/**
Jaeden Ameroff2f4932018-06-14 11:38:50 +0100621 * \def MBEDTLS_CIPHER_MODE_OFB
622 *
623 * Enable Output Feedback mode (OFB) for symmetric ciphers.
624 */
625#define MBEDTLS_CIPHER_MODE_OFB
626
627/**
628 * \def MBEDTLS_CIPHER_MODE_XTS
629 *
630 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
631 */
632#define MBEDTLS_CIPHER_MODE_XTS
633
634/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635 * \def MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000636 *
637 * Enable NULL cipher.
638 * Warning: Only do so when you know what you are doing. This allows for
639 * encryption or channels without any security!
640 *
Jaeden Amero7242ea62019-04-10 18:00:15 +0100641 * This module is required to support the TLS ciphersuites that use the NULL
642 * cipher.
Paul Bakkerfab5c822012-02-06 16:45:10 +0000643 *
Jaeden Amero1c66e482018-11-02 18:15:18 +0000644 * Uncomment this macro to enable the NULL cipher
Paul Bakkerfab5c822012-02-06 16:45:10 +0000645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200646//#define MBEDTLS_CIPHER_NULL_CIPHER
Paul Bakkerfab5c822012-02-06 16:45:10 +0000647
648/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100649 * \def MBEDTLS_CIPHER_PADDING_PKCS7
Paul Bakker48e93c82013-08-14 12:21:18 +0200650 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100651 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
652 * specific padding modes in the cipher layer with cipher modes that support
653 * padding (e.g. CBC)
Paul Bakker48e93c82013-08-14 12:21:18 +0200654 *
655 * If you disable all padding modes, only full blocks can be used with CBC.
656 *
657 * Enable padding modes in the cipher layer.
658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659#define MBEDTLS_CIPHER_PADDING_PKCS7
660#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
661#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
662#define MBEDTLS_CIPHER_PADDING_ZEROS
Paul Bakker48e93c82013-08-14 12:21:18 +0200663
664/**
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100665 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200666 *
Manuel Pégourié-Gonnard76da60c2016-01-04 13:51:01 +0100667 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
668 * module. By default all supported curves are enabled.
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200669 *
670 * Comment macros to disable the curve and functions for it
671 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200672#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
673#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
674#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
675#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
676#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
677#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
678#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
679#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
680#define MBEDTLS_ECP_DP_BP256R1_ENABLED
681#define MBEDTLS_ECP_DP_BP384R1_ENABLED
682#define MBEDTLS_ECP_DP_BP512R1_ENABLED
Manuel Pégourié-Gonnard07894332015-06-23 00:18:41 +0200683#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Nicholas Wilson08f3ef12015-11-10 13:10:01 +0000684#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Paul Bakker5dc6b5f2013-06-29 23:26:34 +0200685
686/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 * \def MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200688 *
689 * Enable specific 'modulo p' routines for each NIST prime.
690 * Depending on the prime and architecture, makes operations 4 to 8 times
691 * faster on the corresponding curve.
692 *
693 * Comment this macro to disable NIST curves optimisation.
694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200695#define MBEDTLS_ECP_NIST_OPTIM
Manuel Pégourié-Gonnardc04c5302013-10-23 16:11:52 +0200696
697/**
Manuel Pégourié-Gonnard4b9c51e2017-04-20 15:50:26 +0200698 * \def MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100699 *
700 * Enable "non-blocking" ECC operations that can return early and be resumed.
701 *
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200702 * This allows various functions to pause by returning
Jaeden Amerode0a41b2018-11-02 18:40:14 +0000703 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in Mbed TLS's SSL module,
704 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in order
705 * to further progress and eventually complete their operation. This is
706 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum number
707 * of ECC operations a function may perform before pausing; see
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200708 * mbedtls_ecp_set_max_ops() for more information.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100709 *
Manuel Pégourié-Gonnard8b7b96b2017-08-23 10:02:51 +0200710 * This is useful in non-threaded environments if you want to avoid blocking
Manuel Pégourié-Gonnardf0bbd7e2018-10-15 13:22:41 +0200711 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100712 *
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200713 * Uncomment this macro to enable restartable ECC computations.
Ron Eldor5ed8c1e2018-11-05 14:04:26 +0200714 *
Ron Eldor19779c42018-11-05 16:58:13 +0200715 * \note This option only works with the default software implementation of
716 * elliptic curve functionality. It is incompatible with
Gilles Peskine43f564f2019-02-22 12:14:02 +0100717 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
718 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100719 */
Manuel Pégourié-Gonnardc9e16a92017-08-15 14:30:59 +0200720//#define MBEDTLS_ECP_RESTARTABLE
Manuel Pégourié-Gonnardc3a3bc72017-03-22 11:17:51 +0100721
722/**
Gilles Peskine43f564f2019-02-22 12:14:02 +0100723 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
724 *
725 * Use a backward compatible ECDH context.
726 *
727 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
728 * defined in `ecdh.h`). For most applications, the choice of format makes
729 * no difference, since all library functions can work with either format,
730 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
731
732 * The new format used when this option is disabled is smaller
733 * (56 bytes on a 32-bit platform). In future versions of the library, it
734 * will support alternative implementations of ECDH operations.
735 * The new format is incompatible with applications that access
736 * context fields directly and with restartable ECP operations.
737 *
738 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
739 * want to access ECDH context fields directly. Otherwise you should
740 * comment out this macro definition.
741 *
742 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
743 *
744 * \note This configuration option is experimental. Future versions of the
745 * library may modify the way the ECDH context layout is configured
746 * and may modify the layout of the new context type.
747 */
748#define MBEDTLS_ECDH_LEGACY_CONTEXT
749
750/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751 * \def MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100752 *
753 * Enable deterministic ECDSA (RFC 6979).
754 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
755 * may result in a compromise of the long-term signing key. This is avoided by
756 * the deterministic variant.
757 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200758 * Requires: MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard5b1a5732014-01-07 16:46:17 +0100759 *
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100760 * Comment this macro to disable deterministic ECDSA.
761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200762#define MBEDTLS_ECDSA_DETERMINISTIC
Manuel Pégourié-Gonnard461d4162014-01-06 10:16:28 +0100763
764/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100766 *
767 * Enhance support for reading EC keys using variants of SEC1 not allowed by
768 * RFC 5915 and RFC 5480.
769 *
770 * Currently this means parsing the SpecifiedECDomain choice of EC
771 * parameters (only known groups are supported, not arbitrary domains, to
772 * avoid validation issues).
773 *
774 * Disable if you only need to support RFC 5915 + 5480 key formats.
775 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776#define MBEDTLS_PK_PARSE_EC_EXTENDED
Manuel Pégourié-Gonnard6fac3512014-03-19 16:39:52 +0100777
778/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200779 * \def MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100780 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200781 * Enable a dummy error function to make use of mbedtls_strerror() in
782 * third party libraries easier when MBEDTLS_ERROR_C is disabled
783 * (no effect when MBEDTLS_ERROR_C is enabled).
Manuel Pégourié-Gonnarddc16aa72014-06-25 12:55:12 +0200784 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200785 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
786 * not using mbedtls_strerror() or error_strerror() in your application.
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100787 *
788 * Disable if you run into name conflicts and want to really remove the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200789 * mbedtls_strerror()
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100790 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200791#define MBEDTLS_ERROR_STRERROR_DUMMY
Paul Bakker8fe40dc2013-02-02 12:43:08 +0100792
793/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200794 * \def MBEDTLS_GENPRIME
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000795 *
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +0200796 * Enable the prime-number generation code.
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200798 * Requires: MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +0000799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800#define MBEDTLS_GENPRIME
Paul Bakker5121ce52009-01-03 21:22:43 +0000801
Paul Bakkerf3b86c12011-01-27 15:24:17 +0000802/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803 * \def MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000804 *
805 * Enable functions that use the filesystem.
806 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200807#define MBEDTLS_FS_IO
Paul Bakker335db3f2011-04-25 15:28:35 +0000808
809/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000811 *
812 * Do not add default entropy sources. These are the platform specific,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813 * mbedtls_timing_hardclock and HAVEGE based poll functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000814 *
Shuo Chen95a0d112014-04-04 21:04:40 -0700815 * This is useful to have more control over the added entropy sources in an
Paul Bakker43655f42011-12-15 20:11:16 +0000816 * application.
817 *
818 * Uncomment this macro to prevent loading of default entropy functions.
Paul Bakker43655f42011-12-15 20:11:16 +0000819 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200820//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
Paul Bakker43655f42011-12-15 20:11:16 +0000821
822/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823 * \def MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000824 *
825 * Do not use built-in platform entropy functions.
826 * This is useful if your platform does not support
827 * standards like the /dev/urandom or Windows CryptoAPI.
828 *
829 * Uncomment this macro to disable the built-in platform entropy functions.
Paul Bakker6083fd22011-12-03 21:45:14 +0000830 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200831//#define MBEDTLS_NO_PLATFORM_ENTROPY
Paul Bakker6083fd22011-12-03 21:45:14 +0000832
833/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200834 * \def MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +0100835 *
836 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
837 * default SHA-512 based one (if both are available).
838 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200839 * Requires: MBEDTLS_SHA256_C
Paul Bakker2ceda572014-02-06 15:55:25 +0100840 *
841 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
842 * if you have performance concerns.
843 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844 * This option is only useful if both MBEDTLS_SHA256_C and
845 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
Paul Bakker2ceda572014-02-06 15:55:25 +0100846 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847//#define MBEDTLS_ENTROPY_FORCE_SHA256
Paul Bakker2ceda572014-02-06 15:55:25 +0100848
849/**
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100850 * \def MBEDTLS_ENTROPY_NV_SEED
851 *
852 * Enable the non-volatile (NV) seed file-based entropy source.
853 * (Also enables the NV seed read/write functions in the platform layer)
854 *
855 * This is crucial (if not required) on systems that do not have a
856 * cryptographic entropy source (in hardware or kernel) available.
857 *
858 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
859 *
Paul Bakker71a597a2016-06-07 10:59:03 +0100860 * \note The read/write functions that are used by the entropy source are
861 * determined in the platform layer, and can be modified at runtime and/or
862 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
863 *
864 * \note If you use the default implementation functions that read a seedfile
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100865 * with regular fopen(), please make sure you make a seedfile with the
866 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
867 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
Paul Bakker71a597a2016-06-07 10:59:03 +0100868 * and written to or you will get an entropy source error! The default
869 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
870 * bytes from the file.
871 *
872 * \note The entropy collector will write to the seed file before entropy is
873 * given to an external source, to update it.
Paul Bakkercf0a9f92016-06-01 11:25:44 +0100874 */
875//#define MBEDTLS_ENTROPY_NV_SEED
876
Gilles Peskine69d7c8b2019-02-19 14:00:31 +0100877/* MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
878 *
879 * In PSA key storage, encode the owner of the key.
880 *
881 * This is only meaningful when building the library as part of a
882 * multi-client service. When you activate this option, you must provide
883 * an implementation of the type psa_key_owner_id_t and a translation
884 * from psa_key_file_id_t to file name in all the storage backends that
885 * you wish to support.
886 *
887 * Note that this option is meant for internal use only and may be removed
888 * without notice.
889 */
890//#define MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
891
Netanel Gonen212a7932018-11-19 12:19:19 +0200892/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200893 * \def MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +0200894 *
895 * Enable debugging of buffer allocator memory issues. Automatically prints
896 * (to stderr) all (fatal) messages on memory allocation issues. Enables
897 * function for 'debug output' of allocated memory.
898 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +0200900 *
901 * Uncomment this macro to let the buffer allocator print out error messages.
Paul Bakkera7ea6a52013-10-15 11:55:10 +0200902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200903//#define MBEDTLS_MEMORY_DEBUG
Paul Bakker6e339b52013-07-03 13:37:05 +0200904
905/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906 * \def MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +0200907 *
908 * Include backtrace information with each allocated block.
909 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200910 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +0200911 * GLIBC-compatible backtrace() an backtrace_symbols() support
912 *
913 * Uncomment this macro to include backtrace information
Paul Bakker6e339b52013-07-03 13:37:05 +0200914 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915//#define MBEDTLS_MEMORY_BACKTRACE
Paul Bakker6e339b52013-07-03 13:37:05 +0200916
917/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +0200919 *
920 * Support external private RSA keys (eg from a HSM) in the PK layer.
921 *
922 * Comment this macro to disable support for external private RSA keys.
923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200924#define MBEDTLS_PK_RSA_ALT_SUPPORT
Manuel Pégourié-Gonnard348bcb32015-03-31 14:01:33 +0200925
926/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927 * \def MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +0200928 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200929 * Enable support for PKCS#1 v1.5 encoding.
930 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200931 * Requires: MBEDTLS_RSA_C
Paul Bakker48377d92013-08-30 12:06:24 +0200932 *
Paul Bakker48377d92013-08-30 12:06:24 +0200933 * This enables support for PKCS#1 v1.5 operations.
934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935#define MBEDTLS_PKCS1_V15
Paul Bakker48377d92013-08-30 12:06:24 +0200936
937/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938 * \def MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +0000939 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +0200940 * Enable support for PKCS#1 v2.1 encoding.
941 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200942 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
Paul Bakker5690efc2011-05-26 13:16:06 +0000943 *
Paul Bakker9dcc3222011-03-08 14:16:06 +0000944 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200946#define MBEDTLS_PKCS1_V21
Paul Bakker9dcc3222011-03-08 14:16:06 +0000947
948/**
Jaeden Amero67a93512018-07-11 16:07:40 +0100949 * \def MBEDTLS_PSA_CRYPTO_SPM
950 *
951 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
952 * Partition Manager) integration which separates the code into two parts: a
953 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
954 * Environment).
955 *
956 * Module: library/psa_crypto.c
957 * Requires: MBEDTLS_PSA_CRYPTO_C
958 *
959 */
960//#define MBEDTLS_PSA_CRYPTO_SPM
961
962/**
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100963 * \def MBEDTLS_PSA_INJECT_ENTROPY
964 *
965 * Enable support for entropy injection at first boot. This feature is
966 * required on systems that do not have a built-in entropy source (TRNG).
967 * This feature is currently not supported on systems that have a built-in
968 * entropy source.
969 *
970 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
971 *
972 */
973//#define MBEDTLS_PSA_INJECT_ENTROPY
974
975/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200976 * \def MBEDTLS_RSA_NO_CRT
Paul Bakker0216cc12011-03-26 13:40:23 +0000977 *
Gilles Peskine9a9e19f2018-06-19 11:56:47 +0200978 * Do not use the Chinese Remainder Theorem
979 * for the RSA private operation.
Paul Bakker0216cc12011-03-26 13:40:23 +0000980 *
981 * Uncomment this macro to disable the use of CRT in RSA.
982 *
Paul Bakker0216cc12011-03-26 13:40:23 +0000983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200984//#define MBEDTLS_RSA_NO_CRT
Paul Bakker15566e42011-04-24 21:19:15 +0000985
986/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200987 * \def MBEDTLS_SELF_TEST
Paul Bakker15566e42011-04-24 21:19:15 +0000988 *
989 * Enable the checkup functions (*_self_test).
990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991#define MBEDTLS_SELF_TEST
Paul Bakker5c721f92011-07-27 16:51:09 +0000992
993/**
Manuel Pégourié-Gonnardeb0d8702015-05-28 12:54:04 +0200994 * \def MBEDTLS_SHA256_SMALLER
995 *
996 * Enable an implementation of SHA-256 that has lower ROM footprint but also
997 * lower performance.
998 *
999 * The default implementation is meant to be a reasonnable compromise between
1000 * performance and size. This version optimizes more aggressively for size at
1001 * the expense of performance. Eg on Cortex-M4 it reduces the size of
1002 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
1003 * 30%.
1004 *
1005 * Uncomment to enable the smaller implementation of SHA256.
1006 */
1007//#define MBEDTLS_SHA256_SMALLER
1008
1009/**
Manuel Pégourié-Gonnard2306d152019-07-17 12:36:53 +02001010 * \def MBEDTLS_SHA512_SMALLER
1011 *
1012 * Enable an implementation of SHA-512 that has lower ROM footprint but also
1013 * lower performance.
1014 *
1015 * Uncomment to enable the smaller implementation of SHA512.
1016 */
1017//#define MBEDTLS_SHA512_SMALLER
1018
1019/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001020 * \def MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001021 *
1022 * Provide your own alternate threading implementation.
1023 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001024 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001025 *
1026 * Uncomment this to allow your own alternate threading implementation.
Paul Bakker2466d932013-09-28 14:40:38 +02001027 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001028//#define MBEDTLS_THREADING_ALT
Paul Bakker2466d932013-09-28 14:40:38 +02001029
1030/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * \def MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001032 *
1033 * Enable the pthread wrapper layer for the threading layer.
1034 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001035 * Requires: MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001036 *
1037 * Uncomment this to enable pthread mutexes.
Paul Bakker2466d932013-09-28 14:40:38 +02001038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039//#define MBEDTLS_THREADING_PTHREAD
Paul Bakker2466d932013-09-28 14:40:38 +02001040
1041/**
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001042 * \def MBEDTLS_USE_PSA_CRYPTO
1043 *
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001044 * Make the X.509 and TLS library use PSA for cryptographic operations, and
1045 * enable new APIs for using keys handled by PSA Crypto.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001046 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001047 * \note Development of this option is currently in progress, and parts of Mbed
1048 * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts
Andrzej Kurekd65b11d2019-04-16 04:20:24 -04001049 * will still continue to work as usual, so enabling this option should not
1050 * break backwards compatibility.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001051 *
Jaeden Amero8dd16902019-07-22 16:39:49 +01001052 * \warning Support for PSA is still an experimental feature.
1053 * Any public API that depends on this option may change
1054 * at any time until this warning is removed.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001055 *
1056 * \warning This option enables new Mbed TLS APIs that are dependent on the
1057 * PSA Crypto API, so can't come with the same stability guarantees as the
1058 * rest of the Mbed TLS APIs. You're welcome to experiment with them, but for
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001059 * now, access to these APIs is opt-in (via enabling the present option), in
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001060 * order to clearly differentiate them from the stable Mbed TLS APIs.
Hanno Becker56a78dd2018-11-19 09:46:26 +00001061 *
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001062 * Requires: MBEDTLS_PSA_CRYPTO_C.
Manuel Pégourié-Gonnard971dea32019-02-01 12:38:40 +01001063 *
Andrzej Kurekd3deb1d2019-04-16 04:14:48 -04001064 * Uncomment this to enable internal use of PSA Crypto and new associated APIs.
Manuel Pégourié-Gonnard26fd7302018-10-22 12:14:52 +02001065 */
1066//#define MBEDTLS_USE_PSA_CRYPTO
1067
1068/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001069 * \def MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001070 *
1071 * Allow run-time checking of compile-time enabled features. Thus allowing users
1072 * to check at run-time if the library is for instance compiled with threading
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001073 * support via mbedtls_version_check_feature().
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001074 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001075 * Requires: MBEDTLS_VERSION_C
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001076 *
1077 * Comment this to disable run-time checking and save ROM space
1078 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079#define MBEDTLS_VERSION_FEATURES
Paul Bakker0f90d7d2014-04-30 11:49:44 +02001080
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001081/* \} name SECTION: mbed TLS feature support */
Paul Bakker0a62cd12011-01-21 11:00:08 +00001082
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001083/**
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001084 * \name SECTION: mbed TLS modules
Paul Bakker0a62cd12011-01-21 11:00:08 +00001085 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001086 * This section enables or disables entire modules in mbed TLS
Paul Bakker0a62cd12011-01-21 11:00:08 +00001087 * \{
1088 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001089
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001090/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001091 * \def MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001092 *
1093 * Enable AES-NI support on x86-64.
1094 *
1095 * Module: library/aesni.c
1096 * Caller: library/aes.c
1097 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001099 *
1100 * This modules adds support for the AES-NI instructions on x86-64
1101 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#define MBEDTLS_AESNI_C
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001103
1104/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001105 * \def MBEDTLS_AES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001106 *
1107 * Enable the AES block cipher.
1108 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001109 * Module: library/aes.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001110 * Caller: library/cipher.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001111 * library/pem.c
Paul Bakker6083fd22011-12-03 21:45:14 +00001112 * library/ctr_drbg.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001113 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001114 * This module is required to support the TLS ciphersuites that use the AES
1115 * cipher.
Paul Bakker6deb37e2013-02-19 13:17:08 +01001116 *
Paul Bakkercff68422013-09-15 20:43:33 +02001117 * PEM_PARSE uses AES for decrypting encrypted keys.
Paul Bakker5121ce52009-01-03 21:22:43 +00001118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119#define MBEDTLS_AES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001120
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001121/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122 * \def MBEDTLS_ARC4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001123 *
1124 * Enable the ARCFOUR stream cipher.
1125 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001126 * Module: library/arc4.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001127 * Caller: library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001128 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001129 * This module is required to support the TLS ciphersuites that use the ARC4
1130 * cipher.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001131 *
1132 * \warning ARC4 is considered a weak cipher and its use constitutes a
1133 * security risk. If possible, we recommend avoidng dependencies on
1134 * it, and considering stronger ciphers instead.
1135 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#define MBEDTLS_ARC4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001138
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001139/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001140 * \def MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001141 *
1142 * Enable the generic ASN1 parser.
1143 *
1144 * Module: library/asn1.c
Jaeden Amerobb1f7012018-11-02 18:15:18 +00001145 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001146 * library/pkcs12.c
1147 * library/pkcs5.c
1148 * library/pkparse.c
Paul Bakkerefc30292011-11-10 14:43:23 +00001149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001150#define MBEDTLS_ASN1_PARSE_C
Paul Bakkerefc30292011-11-10 14:43:23 +00001151
1152/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001153 * \def MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001154 *
1155 * Enable the generic ASN1 writer.
1156 *
1157 * Module: library/asn1write.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001158 * Caller: library/ecdsa.c
1159 * library/pkwrite.c
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001161#define MBEDTLS_ASN1_WRITE_C
Paul Bakkerbdb912d2012-02-13 23:11:30 +00001162
1163/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001164 * \def MBEDTLS_BASE64_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001165 *
1166 * Enable the Base64 module.
1167 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001168 * Module: library/base64.c
Paul Bakker5690efc2011-05-26 13:16:06 +00001169 * Caller: library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001170 *
Paul Bakker5690efc2011-05-26 13:16:06 +00001171 * This module is required for PEM support (required by X.509).
Paul Bakker5121ce52009-01-03 21:22:43 +00001172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001173#define MBEDTLS_BASE64_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001174
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001175/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176 * \def MBEDTLS_BIGNUM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001177 *
Paul Bakker9a736322012-11-14 12:39:52 +00001178 * Enable the multi-precision integer library.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001179 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001180 * Module: library/bignum.c
1181 * Caller: library/dhm.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001182 * library/ecp.c
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02001183 * library/ecdsa.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001184 * library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01001185 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001186 *
Manuel Pégourié-Gonnardbf319772014-06-25 13:00:17 +02001187 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
Paul Bakker5121ce52009-01-03 21:22:43 +00001188 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189#define MBEDTLS_BIGNUM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001190
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001191/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 * \def MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00001193 *
1194 * Enable the Blowfish block cipher.
1195 *
1196 * Module: library/blowfish.c
1197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001198#define MBEDTLS_BLOWFISH_C
Paul Bakkera9379c02012-07-04 11:02:11 +00001199
1200/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201 * \def MBEDTLS_CAMELLIA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001202 *
1203 * Enable the Camellia block cipher.
1204 *
Paul Bakker38119b12009-01-10 23:31:23 +00001205 * Module: library/camellia.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001206 * Caller: library/cipher.c
Paul Bakker38119b12009-01-10 23:31:23 +00001207 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001208 * This module is required to support the TLS ciphersuites that use the
1209 * Camellia cipher.
Paul Bakker38119b12009-01-10 23:31:23 +00001210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211#define MBEDTLS_CAMELLIA_C
Paul Bakker38119b12009-01-10 23:31:23 +00001212
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001213/**
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001214 * \def MBEDTLS_ARIA_C
1215 *
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01001216 * Enable the ARIA block cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001217 *
1218 * Module: library/aria.c
Manuel Pégourié-Gonnard525168c2018-02-28 10:47:02 +01001219 * Caller: library/cipher.c
1220 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001221 * This module is required to support the TLS ciphersuites that use the
1222 * ARIA cipher.
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001223 */
Manuel Pégourié-Gonnard2268b962018-02-27 12:22:36 +01001224//#define MBEDTLS_ARIA_C
Markku-Juhani O. Saarinen3c0b53b2017-11-30 16:00:34 +00001225
1226/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001227 * \def MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001228 *
1229 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
1230 *
1231 * Module: library/ccm.c
1232 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001234 *
Jaeden Amero1c66e482018-11-02 18:15:18 +00001235 * This module is required to support AES-CCM ciphersuites in TLS.
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237#define MBEDTLS_CCM_C
Manuel Pégourié-Gonnarda6916fa2014-05-02 15:17:29 +02001238
1239/**
Daniel King34b822c2016-05-15 17:28:08 -03001240 * \def MBEDTLS_CHACHA20_C
1241 *
1242 * Enable the ChaCha20 stream cipher.
1243 *
1244 * Module: library/chacha20.c
1245 */
1246#define MBEDTLS_CHACHA20_C
1247
1248/**
Manuel Pégourié-Gonnarde533b222018-06-04 12:23:19 +02001249 * \def MBEDTLS_CHACHAPOLY_C
1250 *
1251 * Enable the ChaCha20-Poly1305 AEAD algorithm.
1252 *
1253 * Module: library/chachapoly.c
1254 *
1255 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
1256 */
1257#define MBEDTLS_CHACHAPOLY_C
1258
1259/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260 * \def MBEDTLS_CIPHER_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001261 *
1262 * Enable the generic cipher layer.
1263 *
Paul Bakker8123e9d2011-01-06 15:37:30 +00001264 * Module: library/cipher.c
Paul Bakker8123e9d2011-01-06 15:37:30 +00001265 *
1266 * Uncomment to enable generic cipher wrappers.
1267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268#define MBEDTLS_CIPHER_C
Paul Bakker8123e9d2011-01-06 15:37:30 +00001269
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001270/**
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001271 * \def MBEDTLS_CMAC_C
1272 *
Simon Butcher327398a2016-10-05 14:09:11 +01001273 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
1274 * ciphers.
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001275 *
1276 * Module: library/cmac.c
1277 *
Simon Butcher69283e52016-10-06 12:49:58 +01001278 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001279 *
1280 */
Gilles Peskinee59236f2018-01-27 23:32:46 +01001281#define MBEDTLS_CMAC_C
Robert Cragiedc5c7b92015-12-11 15:49:45 +00001282
1283/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284 * \def MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001285 *
Nir Sonnenscheince266e42018-08-29 10:11:46 +03001286 * Enable the CTR_DRBG AES-based random generator.
1287 * The CTR_DRBG generator uses AES-256 by default.
1288 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001289 *
1290 * Module: library/ctr_drbg.c
1291 * Caller:
1292 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293 * Requires: MBEDTLS_AES_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001294 *
Nir Sonnenschein521e8a92018-09-03 14:10:52 +03001295 * This module provides the CTR_DRBG AES random number generator.
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001296 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001297#define MBEDTLS_CTR_DRBG_C
Paul Bakker0e04d0e2011-11-27 14:46:59 +00001298
1299/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 * \def MBEDTLS_DES_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001301 *
1302 * Enable the DES block cipher.
1303 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001304 * Module: library/des.c
Paul Bakker6deb37e2013-02-19 13:17:08 +01001305 * Caller: library/pem.c
Manuel Pégourié-Gonnardfdd43542018-02-28 10:49:02 +01001306 * library/cipher.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001308 * This module is required to support the TLS ciphersuites that use the DES
1309 * cipher.
Paul Bakker6deb37e2013-02-19 13:17:08 +01001310 *
Paul Bakkercff68422013-09-15 20:43:33 +02001311 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001312 *
1313 * \warning DES is considered a weak cipher and its use constitutes a
1314 * security risk. We recommend considering stronger ciphers instead.
Paul Bakker5121ce52009-01-03 21:22:43 +00001315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001316#define MBEDTLS_DES_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001317
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001318/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319 * \def MBEDTLS_DHM_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001320 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001321 * Enable the Diffie-Hellman-Merkle module.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001322 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001323 * Module: library/dhm.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001324 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001325 * This module is used by the following key exchanges:
1326 * DHE-RSA, DHE-PSK
Hanno Beckera2f6b722017-09-28 10:33:29 +01001327 *
Hanno Beckerf9734b32017-10-03 12:09:22 +01001328 * \warning Using DHE constitutes a security risk as it
1329 * is not possible to validate custom DH parameters.
1330 * If possible, it is recommended users should consider
1331 * preferring other methods of key exchange.
1332 * See dhm.h for more details.
Hanno Beckera2f6b722017-09-28 10:33:29 +01001333 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001335#define MBEDTLS_DHM_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001336
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001337/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 * \def MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001339 *
1340 * Enable the elliptic curve Diffie-Hellman library.
1341 *
1342 * Module: library/ecdh.c
Paul Bakker41c83d32013-03-20 14:39:14 +01001343 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001344 * This module is used by the following key exchanges:
1345 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001346 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347 * Requires: MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349#define MBEDTLS_ECDH_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001350
1351/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352 * \def MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001353 *
1354 * Enable the elliptic curve DSA library.
1355 *
1356 * Module: library/ecdsa.c
1357 * Caller:
1358 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001359 * This module is used by the following key exchanges:
1360 * ECDHE-ECDSA
1361 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001362 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001364#define MBEDTLS_ECDSA_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001365
1366/**
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001367 * \def MBEDTLS_ECJPAKE_C
1368 *
1369 * Enable the elliptic curve J-PAKE library.
1370 *
Manuel Pégourié-Gonnard75df9022015-09-16 23:21:01 +02001371 * \warning This is currently experimental. EC J-PAKE support is based on the
1372 * Thread v1.0.0 specification; incompatible changes to the specification
1373 * might still happen. For this reason, this is disabled by default.
1374 *
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001375 * Module: library/ecjpake.c
1376 * Caller:
1377 *
1378 * This module is used by the following key exchanges:
1379 * ECJPAKE
1380 *
1381 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
1382 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001383//#define MBEDTLS_ECJPAKE_C
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001384
1385/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001386 * \def MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001387 *
1388 * Enable the elliptic curve over GF(p) library.
1389 *
1390 * Module: library/ecp.c
1391 * Caller: library/ecdh.c
1392 * library/ecdsa.c
Manuel Pégourié-Gonnard4d8685b2015-08-05 15:44:42 +02001393 * library/ecjpake.c
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001396 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397#define MBEDTLS_ECP_C
Paul Bakkerd589a0d2013-03-13 16:30:17 +01001398
1399/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400 * \def MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001401 *
1402 * Enable the platform-specific entropy code.
1403 *
1404 * Module: library/entropy.c
1405 * Caller:
1406 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001408 *
1409 * This module provides a generic entropy pool
1410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411#define MBEDTLS_ENTROPY_C
Paul Bakker6083fd22011-12-03 21:45:14 +00001412
1413/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001414 * \def MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00001415 *
1416 * Enable error code to error string conversion.
1417 *
1418 * Module: library/error.c
1419 * Caller:
1420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 * This module enables mbedtls_strerror().
Paul Bakker9d781402011-05-09 16:17:09 +00001422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001423#define MBEDTLS_ERROR_C
Paul Bakker9d781402011-05-09 16:17:09 +00001424
1425/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001426 * \def MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00001427 *
Jaeden Amero7accf442019-04-10 18:13:57 +01001428 * Enable the Galois/Counter Mode (GCM).
Paul Bakker89e80c92012-03-20 13:50:09 +00001429 *
1430 * Module: library/gcm.c
1431 *
Jaeden Amero651ae682019-04-10 18:19:16 +01001432 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Paul Bakker645ce3a2012-10-31 12:32:41 +00001433 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001434 * This module is required to support the TLS ciphersuites that use GCM.
Paul Bakker89e80c92012-03-20 13:50:09 +00001435 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436#define MBEDTLS_GCM_C
Paul Bakker89e80c92012-03-20 13:50:09 +00001437
1438/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001439 * \def MBEDTLS_HAVEGE_C
1440 *
1441 * Enable the HAVEGE random generator.
1442 *
1443 * Warning: the HAVEGE random generator is not suitable for virtualized
1444 * environments
1445 *
1446 * Warning: the HAVEGE random generator is dependent on timing and specific
1447 * processor traits. It is therefore not advised to use HAVEGE as
1448 * your applications primary random generator or primary entropy pool
1449 * input. As a secondary input to your entropy pool, it IS able add
1450 * the (limited) extra entropy it provides.
1451 *
1452 * Module: library/havege.c
1453 * Caller:
1454 *
1455 * Requires: MBEDTLS_TIMING_C
1456 *
1457 * Uncomment to enable the HAVEGE random generator.
1458 */
1459//#define MBEDTLS_HAVEGE_C
1460
1461/**
Thomas Fossati656864b2016-07-17 08:51:22 +01001462 * \def MBEDTLS_HKDF_C
1463 *
1464 * Enable the HKDF algorithm (RFC 5869).
1465 *
1466 * Module: library/hkdf.c
1467 * Caller:
1468 *
1469 * Requires: MBEDTLS_MD_C
1470 *
1471 * This module adds support for the Hashed Message Authentication Code
1472 * (HMAC)-based key derivation function (HKDF).
1473 */
1474#define MBEDTLS_HKDF_C
1475
1476/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001477 * \def MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001478 *
1479 * Enable the HMAC_DRBG random generator.
1480 *
1481 * Module: library/hmac_drbg.c
1482 * Caller:
1483 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484 * Requires: MBEDTLS_MD_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001485 *
1486 * Uncomment to enable the HMAC_DRBG random number geerator.
1487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001488#define MBEDTLS_HMAC_DRBG_C
Manuel Pégourié-Gonnard490bdf32014-01-27 14:03:10 +01001489
1490/**
Ron Eldor466a57f2018-05-03 16:54:28 +03001491 * \def MBEDTLS_NIST_KW_C
1492 *
1493 * Enable the Key Wrapping mode for 128-bit block ciphers,
1494 * as defined in NIST SP 800-38F. Only KW and KWP modes
1495 * are supported. At the moment, only AES is approved by NIST.
1496 *
1497 * Module: library/nist_kw.c
1498 *
1499 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
1500 */
1501//#define MBEDTLS_NIST_KW_C
1502
1503/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504 * \def MBEDTLS_MD_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001505 *
1506 * Enable the generic message digest layer.
1507 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001508 * Module: library/md.c
Paul Bakker17373852011-01-06 14:20:01 +00001509 * Caller:
1510 *
1511 * Uncomment to enable generic message digest wrappers.
1512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#define MBEDTLS_MD_C
Paul Bakker17373852011-01-06 14:20:01 +00001514
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001515/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001516 * \def MBEDTLS_MD2_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001517 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001518 * Enable the MD2 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001519 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001520 * Module: library/md2.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001521 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00001522 *
1523 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001524 *
1525 * \warning MD2 is considered a weak message digest and its use constitutes a
1526 * security risk. If possible, we recommend avoiding dependencies on
1527 * it, and considering stronger message digests instead.
1528 *
Paul Bakker6506aff2009-07-28 20:52:02 +00001529 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001530//#define MBEDTLS_MD2_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001531
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001532/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001533 * \def MBEDTLS_MD4_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001534 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001535 * Enable the MD4 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001536 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001537 * Module: library/md4.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001538 * Caller:
Paul Bakker5121ce52009-01-03 21:22:43 +00001539 *
1540 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001541 *
1542 * \warning MD4 is considered a weak message digest and its use constitutes a
1543 * security risk. If possible, we recommend avoiding dependencies on
1544 * it, and considering stronger message digests instead.
1545 *
Paul Bakker6506aff2009-07-28 20:52:02 +00001546 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001547//#define MBEDTLS_MD4_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001548
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001549/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 * \def MBEDTLS_MD5_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001551 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001552 * Enable the MD5 hash algorithm.
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001553 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001554 * Module: library/md5.c
1555 * Caller: library/md.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001556 * library/pem.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001557 *
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001558 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
1559 * depending on the handshake parameters. Further, it is used for checking
1560 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
1561 * encrypted keys.
1562 *
1563 * \warning MD5 is considered a weak message digest and its use constitutes a
1564 * security risk. If possible, we recommend avoiding dependencies on
1565 * it, and considering stronger message digests instead.
1566 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001567 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001568#define MBEDTLS_MD5_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001569
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001570/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001572 *
1573 * Enable the buffer allocator implementation that makes use of a (stack)
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02001574 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001575 * calls)
Paul Bakker6e339b52013-07-03 13:37:05 +02001576 *
1577 * Module: library/memory_buffer_alloc.c
1578 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579 * Requires: MBEDTLS_PLATFORM_C
1580 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
Paul Bakker6e339b52013-07-03 13:37:05 +02001581 *
1582 * Enable this module to enable the buffer memory allocator.
Paul Bakker6e339b52013-07-03 13:37:05 +02001583 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001584//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Paul Bakker6e339b52013-07-03 13:37:05 +02001585
1586/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001587 * \def MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02001588 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001589 * Enable the OID database.
Paul Bakkerc70b9822013-04-07 22:00:46 +02001590 *
1591 * Module: library/oid.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001592 * Caller: library/asn1write.c
1593 * library/pkcs5.c
1594 * library/pkparse.c
1595 * library/pkwrite.c
1596 * library/rsa.c
Paul Bakkerc70b9822013-04-07 22:00:46 +02001597 *
1598 * This modules translates between OIDs and internal values.
1599 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600#define MBEDTLS_OID_C
Paul Bakkerc70b9822013-04-07 22:00:46 +02001601
1602/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603 * \def MBEDTLS_PADLOCK_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001604 *
1605 * Enable VIA Padlock support on x86.
1606 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001607 * Module: library/padlock.c
1608 * Caller: library/aes.c
1609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001610 * Requires: MBEDTLS_HAVE_ASM
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001611 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001612 * This modules adds support for the VIA PadLock on x86.
1613 */
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001614#define MBEDTLS_PADLOCK_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001615
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001616/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001617 * \def MBEDTLS_PEM_PARSE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00001618 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001619 * Enable PEM decoding / parsing.
Paul Bakker96743fc2011-02-12 14:30:57 +00001620 *
1621 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001622 * Caller: library/dhm.c
Paul Bakkercff68422013-09-15 20:43:33 +02001623 * library/pkparse.c
Paul Bakker96743fc2011-02-12 14:30:57 +00001624 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001625 * Requires: MBEDTLS_BASE64_C
Paul Bakker5690efc2011-05-26 13:16:06 +00001626 *
Paul Bakkercff68422013-09-15 20:43:33 +02001627 * This modules adds support for decoding / parsing PEM files.
Paul Bakker96743fc2011-02-12 14:30:57 +00001628 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001629#define MBEDTLS_PEM_PARSE_C
Paul Bakkercff68422013-09-15 20:43:33 +02001630
1631/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001632 * \def MBEDTLS_PEM_WRITE_C
Paul Bakkercff68422013-09-15 20:43:33 +02001633 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001634 * Enable PEM encoding / writing.
Paul Bakkercff68422013-09-15 20:43:33 +02001635 *
1636 * Module: library/pem.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001637 * Caller: library/pkwrite.c
Paul Bakkercff68422013-09-15 20:43:33 +02001638 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639 * Requires: MBEDTLS_BASE64_C
Paul Bakkercff68422013-09-15 20:43:33 +02001640 *
1641 * This modules adds support for encoding / writing PEM files.
1642 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643#define MBEDTLS_PEM_WRITE_C
Paul Bakker96743fc2011-02-12 14:30:57 +00001644
1645/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001646 * \def MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001647 *
1648 * Enable the generic public (asymetric) key layer.
1649 *
1650 * Module: library/pk.c
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001651 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001652 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
Manuel Pégourié-Gonnard1a483832013-09-20 12:29:15 +02001653 *
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001654 * Uncomment to enable generic public key wrappers.
1655 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656#define MBEDTLS_PK_C
Manuel Pégourié-Gonnardc40b4c32013-08-22 13:29:31 +02001657
1658/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001659 * \def MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001660 *
1661 * Enable the generic public (asymetric) key parser.
1662 *
1663 * Module: library/pkparse.c
Paul Bakker4606c732013-09-15 17:04:23 +02001664 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001665 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02001666 *
1667 * Uncomment to enable generic public key parse functions.
1668 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001669#define MBEDTLS_PK_PARSE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001670
1671/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001672 * \def MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001673 *
Paul Bakkerf20ba4b2013-09-16 22:46:20 +02001674 * Enable the generic public (asymetric) key writer.
Paul Bakker4606c732013-09-15 17:04:23 +02001675 *
1676 * Module: library/pkwrite.c
Paul Bakker4606c732013-09-15 17:04:23 +02001677 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001678 * Requires: MBEDTLS_PK_C
Paul Bakker4606c732013-09-15 17:04:23 +02001679 *
1680 * Uncomment to enable generic public key write functions.
1681 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001682#define MBEDTLS_PK_WRITE_C
Paul Bakker4606c732013-09-15 17:04:23 +02001683
1684/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001685 * \def MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001686 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001687 * Enable PKCS#5 functions.
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001688 *
1689 * Module: library/pkcs5.c
1690 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691 * Requires: MBEDTLS_MD_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001692 *
1693 * This module adds support for the PKCS#5 functions.
1694 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001695#define MBEDTLS_PKCS5_C
Paul Bakkerb0c19a42013-06-24 19:26:38 +02001696
1697/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001698 * \def MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02001699 *
Manuel Pégourié-Gonnard09fff7e2013-09-20 13:45:36 +02001700 * Enable PKCS#12 PBE functions.
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02001701 * Adds algorithms for parsing PKCS#8 encrypted private keys
1702 *
1703 * Module: library/pkcs12.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001704 * Caller: library/pkparse.c
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02001705 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
1707 * Can use: MBEDTLS_ARC4_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02001708 *
1709 * This module enables PKCS#12 functions.
1710 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#define MBEDTLS_PKCS12_C
Paul Bakkerf1f21fe2013-06-24 19:17:19 +02001712
1713/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714 * \def MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01001715 *
1716 * Enable the platform abstraction layer that allows you to re-assign
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02001717 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
Paul Bakker747a83a2014-02-01 22:50:07 +01001718 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
1720 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
Rich Evans16f8cd82015-02-06 16:14:34 +00001721 * above to be specified at runtime or compile time respectively.
Paul Bakker747a83a2014-02-01 22:50:07 +01001722 *
Manuel Pégourié-Gonnard6c0c8e02015-06-22 10:23:34 +02001723 * \note This abstraction layer must be enabled on Windows (including MSYS2)
1724 * as other module rely on it for a fixed snprintf implementation.
1725 *
Paul Bakker747a83a2014-02-01 22:50:07 +01001726 * Module: library/platform.c
1727 * Caller: Most other .c files
1728 *
1729 * This module enables abstraction of common (libc) functions.
1730 */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02001731#define MBEDTLS_PLATFORM_C
Paul Bakker747a83a2014-02-01 22:50:07 +01001732
1733/**
Daniel Kingadc32c02016-05-16 18:25:45 -03001734 * \def MBEDTLS_POLY1305_C
1735 *
1736 * Enable the Poly1305 MAC algorithm.
1737 *
1738 * Module: library/poly1305.c
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001739 * Caller: library/chachapoly.c
Daniel Kingadc32c02016-05-16 18:25:45 -03001740 */
1741#define MBEDTLS_POLY1305_C
1742
1743/**
Jaeden Ameroe852df82018-09-14 12:00:46 +01001744 * \def MBEDTLS_PSA_CRYPTO_C
Gilles Peskinee59236f2018-01-27 23:32:46 +01001745 *
1746 * Enable the Platform Security Architecture cryptography API.
1747 *
Manuel Pégourié-Gonnardde7636e2019-02-01 12:33:29 +01001748 * \warning The PSA Crypto API is still beta status. While you're welcome to
1749 * experiment using it, incompatible API changes are still possible, and some
1750 * parts may not have reached the same quality as the rest of Mbed TLS yet.
Jaeden Amero484ee332018-10-25 17:38:05 +01001751 *
Gilles Peskinee59236f2018-01-27 23:32:46 +01001752 * Module: library/psa_crypto.c
1753 *
1754 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
1755 *
1756 */
1757#define MBEDTLS_PSA_CRYPTO_C
1758
1759/**
Gilles Peskinea8ade162019-06-26 11:24:49 +02001760 * \def MBEDTLS_PSA_CRYPTO_SE_C
1761 *
1762 * Enable secure element support in the Platform Security Architecture
1763 * cryptography API.
1764 *
Gilles Peskined0e66b02019-07-24 13:52:51 +02001765 * \warning This feature is not yet suitable for production. It is provided
1766 * for API evaluation and testing purposes only.
1767 *
Gilles Peskinea8ade162019-06-26 11:24:49 +02001768 * Module: library/psa_crypto_se.c
1769 *
1770 * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C
1771 *
1772 */
Gilles Peskined0e66b02019-07-24 13:52:51 +02001773//#define MBEDTLS_PSA_CRYPTO_SE_C
Gilles Peskinea8ade162019-06-26 11:24:49 +02001774
1775/**
Darryl Greendb2b8db2018-06-15 13:06:04 +01001776 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
1777 *
1778 * Enable the Platform Security Architecture persistent key storage.
1779 *
1780 * Module: library/psa_crypto_storage.c
1781 *
Gilles Peskine088b77f2019-02-24 17:00:27 +01001782 * Requires: MBEDTLS_PSA_CRYPTO_C,
1783 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
1784 * the PSA ITS interface
Darryl Greendb2b8db2018-06-15 13:06:04 +01001785 */
1786#define MBEDTLS_PSA_CRYPTO_STORAGE_C
1787
1788/**
Gilles Peskine6194dc22018-11-16 22:24:15 +01001789 * \def MBEDTLS_PSA_ITS_FILE_C
1790 *
1791 * Enable the emulation of the Platform Security Architecture
1792 * Internal Trusted Storage (PSA ITS) over files.
1793 *
1794 * Module: library/psa_its_file.c
1795 *
1796 * Requires: MBEDTLS_FS_IO
1797 */
1798#define MBEDTLS_PSA_ITS_FILE_C
1799
1800/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001801 * \def MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01001802 *
1803 * Enable the RIPEMD-160 hash algorithm.
1804 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001805 * Module: library/ripemd160.c
1806 * Caller: library/md.c
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01001807 *
1808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809#define MBEDTLS_RIPEMD160_C
Manuel Pégourié-Gonnardcab4a882014-01-17 12:42:35 +01001810
1811/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 * \def MBEDTLS_RSA_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001813 *
1814 * Enable the RSA public-key cryptosystem.
1815 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001816 * Module: library/rsa.c
Hanno Beckera565f542017-10-11 11:00:19 +01001817 * library/rsa_internal.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001818 *
Manuel Pégourié-Gonnard9d703732013-10-25 18:01:50 +02001819 * This module is used by the following key exchanges:
1820 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
Paul Bakker5690efc2011-05-26 13:16:06 +00001821 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001822 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001823 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824#define MBEDTLS_RSA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001825
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001826/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001827 * \def MBEDTLS_SHA1_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001828 *
1829 * Enable the SHA1 cryptographic hash algorithm.
1830 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001831 * Module: library/sha1.c
1832 * Caller: library/md.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001833 *
Gilles Peskine5e79cb32017-05-04 16:17:21 +02001834 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
1835 * depending on the handshake parameters, and for SHA1-signed certificates.
Hanno Beckerbbca8c52017-09-25 14:53:51 +01001836 *
1837 * \warning SHA-1 is considered a weak message digest and its use constitutes
1838 * a security risk. If possible, we recommend avoiding dependencies
1839 * on it, and considering stronger message digests instead.
1840 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001842#define MBEDTLS_SHA1_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001843
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001844/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001845 * \def MBEDTLS_SHA256_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001846 *
1847 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
1848 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001849 * Module: library/sha256.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001850 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00001851 * library/md.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001852 *
1853 * This module adds support for SHA-224 and SHA-256.
Paul Bakker769075d2012-11-24 11:26:46 +01001854 * This module is required for the SSL/TLS 1.2 PRF function.
Paul Bakker5121ce52009-01-03 21:22:43 +00001855 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001856#define MBEDTLS_SHA256_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001857
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001858/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001859 * \def MBEDTLS_SHA512_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001860 *
1861 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
1862 *
Simon Butcher2cb47392016-11-04 12:23:11 +00001863 * Module: library/sha512.c
Manuel Pégourié-Gonnardfe286462013-09-20 14:10:14 +02001864 * Caller: library/entropy.c
Simon Butcher2cb47392016-11-04 12:23:11 +00001865 * library/md.c
Paul Bakker5121ce52009-01-03 21:22:43 +00001866 *
1867 * This module adds support for SHA-384 and SHA-512.
1868 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869#define MBEDTLS_SHA512_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001870
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001871/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001872 * \def MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001873 *
1874 * Enable the threading abstraction layer.
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001875 * By default mbed TLS assumes it is used in a non-threaded environment or that
Paul Bakker2466d932013-09-28 14:40:38 +02001876 * contexts are not shared between threads. If you do intend to use contexts
1877 * between threads, you will need to enable this layer to prevent race
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001878 * conditions. See also our Knowledge Base article about threading:
1879 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
Paul Bakker2466d932013-09-28 14:40:38 +02001880 *
1881 * Module: library/threading.c
1882 *
1883 * This allows different threading implementations (self-implemented or
1884 * provided).
1885 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886 * You will have to enable either MBEDTLS_THREADING_ALT or
1887 * MBEDTLS_THREADING_PTHREAD.
Paul Bakker2466d932013-09-28 14:40:38 +02001888 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001889 * Enable this layer to allow use of mutexes within mbed TLS
Paul Bakker2466d932013-09-28 14:40:38 +02001890 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001891//#define MBEDTLS_THREADING_C
Paul Bakker2466d932013-09-28 14:40:38 +02001892
1893/**
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001894 * \def MBEDTLS_TIMING_C
1895 *
1896 * Enable the semi-portable timing interface.
1897 *
1898 * \note The provided implementation only works on POSIX/Unix (including Linux,
1899 * BSD and OS X) and Windows. On other platforms, you can either disable that
Jaeden Amero1c66e482018-11-02 18:15:18 +00001900 * module and provide your own implementations of the callbacks needed by Mbed
1901 * TLS's \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and
1902 * provide your own implementation of the whole module by setting
Gilles Peskine9a9e19f2018-06-19 11:56:47 +02001903 * \c MBEDTLS_TIMING_ALT in the current file.
1904 *
1905 * \note See also our Knowledge Base article about porting to a new
1906 * environment:
1907 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
1908 *
1909 * Module: library/timing.c
1910 * Caller: library/havege.c
1911 *
1912 * This module is used by the HAVEGE random number generator.
1913 */
1914#define MBEDTLS_TIMING_C
1915
1916/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001917 * \def MBEDTLS_VERSION_C
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001918 *
1919 * Enable run-time version information.
1920 *
Paul Bakker0a62cd12011-01-21 11:00:08 +00001921 * Module: library/version.c
1922 *
1923 * This module provides run-time version information.
1924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001925#define MBEDTLS_VERSION_C
Paul Bakker0a62cd12011-01-21 11:00:08 +00001926
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001927/**
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001928 * \def MBEDTLS_XTEA_C
Paul Bakker5121ce52009-01-03 21:22:43 +00001929 *
Paul Bakkerf3b86c12011-01-27 15:24:17 +00001930 * Enable the XTEA block cipher.
1931 *
Paul Bakker7a7c78f2009-01-04 18:15:48 +00001932 * Module: library/xtea.c
1933 * Caller:
1934 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935#define MBEDTLS_XTEA_C
Manuel Pégourié-Gonnard39d2adb2012-10-31 09:26:55 +01001936
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001937/* \} name SECTION: mbed TLS modules */
Paul Bakker7a7c78f2009-01-04 18:15:48 +00001938
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001939/**
1940 * \name SECTION: Module configuration options
1941 *
1942 * This section allows for the setting of module specific sizes and
1943 * configuration options. The default values are already present in the
1944 * relevant header files and should suffice for the regular use cases.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001945 *
Paul Bakker088c5c52014-04-25 11:11:10 +02001946 * Our advice is to enable options and change their values here
1947 * only if you have a good reason and know the consequences.
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001948 *
1949 * Please check the respective header file for documentation on these
1950 * parameters (to prevent duplicate documentation).
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001951 * \{
1952 */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001953
Paul Bakker088c5c52014-04-25 11:11:10 +02001954/* MPI / BIGNUM options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001955//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
1956//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001957
Paul Bakker088c5c52014-04-25 11:11:10 +02001958/* CTR_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001959//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
1960//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1961//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1962//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1963//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Nir Sonnenscheince266e42018-08-29 10:11:46 +03001964//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY /**< Use 128-bit key for CTR_DRBG - may reduce security (see ctr_drbg.h) */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001965
Paul Bakker088c5c52014-04-25 11:11:10 +02001966/* HMAC_DRBG options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001967//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1968//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1969//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1970//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001971
Paul Bakker088c5c52014-04-25 11:11:10 +02001972/* ECP options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
1974//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
1975//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
Manuel Pégourié-Gonnard0520b602014-01-30 19:43:46 +01001976
Paul Bakker088c5c52014-04-25 11:11:10 +02001977/* Entropy options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
1979//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
Andres AG7abc9742016-09-23 17:58:49 +01001980//#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 +01001981
Paul Bakker088c5c52014-04-25 11:11:10 +02001982/* Memory buffer allocator options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
Paul Bakker9bcf16c2013-06-24 19:31:17 +02001984
Paul Bakker088c5c52014-04-25 11:11:10 +02001985/* Platform options */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986//#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 +02001987//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001988//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
1989//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01001990//#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 +02001991//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
1992//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01001993/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001994//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
Janos Follath91947442016-03-18 13:49:27 +00001995//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
1996//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01001997//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
1998//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
1999//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
Paul Bakker6e339b52013-07-03 13:37:05 +02002000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002001/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
2002/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
Manuel Pégourié-Gonnardb9ef1182015-05-26 16:15:20 +02002003//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002004//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
2005//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
Andres Amaya Garcia1e4ec662016-07-20 10:16:25 +01002006//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
2007//#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 +02002008//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
2009//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Antonin Décimo36e89b52019-01-23 15:24:37 +01002010/* Note: your snprintf must correctly zero-terminate the buffer! */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002011//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
k-stachowiak723f8672018-07-16 14:27:07 +02002012//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Paul Bakkercf0a9f92016-06-01 11:25:44 +01002013//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
2014//#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 +02002015
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002016/**
2017 * \brief This macro is invoked by the library when an invalid parameter
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002018 * is detected that is only checked with #MBEDTLS_CHECK_PARAMS
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002019 * (see the documentation of that option for context).
2020 *
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002021 * When you leave this undefined here, the library provides
2022 * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT
2023 * is defined, the default definition is `assert(cond)`,
2024 * otherwise the default definition calls a function
2025 * mbedtls_param_failed(). This function is declared in
2026 * `platform_util.h` for the benefit of the library, but
2027 * you need to define in your application.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002028 *
2029 * When you define this here, this replaces the default
2030 * definition in platform_util.h (which no longer declares the
2031 * function mbedtls_param_failed()) and it is your responsibility
2032 * to make sure this macro expands to something suitable (in
2033 * particular, that all the necessary declarations are visible
2034 * from within the library - you can ensure that by providing
2035 * them in this file next to the macro definition).
Gilles Peskinec7ad1222019-06-13 16:44:19 +02002036 * If you define this macro to call `assert`, also define
2037 * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files
2038 * include `<assert.h>`.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002039 *
2040 * Note that you may define this macro to expand to nothing, in
2041 * which case you don't have to worry about declarations or
2042 * definitions. However, you will then be notified about invalid
2043 * parameters only in non-void functions, and void function will
2044 * just silently return early on invalid parameters, which
2045 * partially negates the benefits of enabling
2046 * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged.
2047 *
2048 * \param cond The expression that should evaluate to true, but doesn't.
2049 */
2050//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond )
2051
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002052/**
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002053 * Uncomment the macro to let mbed TLS use your alternate implementation of
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002054 * mbedtls_platform_zeroize(). This replaces the default implementation in
2055 * platform_util.c.
Andres Amaya Garcia6606d5c2018-03-08 20:25:29 +00002056 *
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002057 * mbedtls_platform_zeroize() is a widely used function across the library to
2058 * zero a block of memory. The implementation is expected to be secure in the
2059 * sense that it has been written to prevent the compiler from removing calls
2060 * to mbedtls_platform_zeroize() as part of redundant code elimination
2061 * optimizations. However, it is difficult to guarantee that calls to
2062 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
2063 * versions of the C language standards do not provide a secure implementation
2064 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
2065 * configure their own implementation of mbedtls_platform_zeroize(), for
Andres Amaya Garciad0ef4682018-04-24 08:31:34 -05002066 * example by using directives specific to their compiler, features from newer
2067 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002068 * their system (e.g explicit_bzero() in BSD).
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002069 */
Andres Amaya Garciac58787f2018-04-17 10:21:45 -05002070//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Andres Amaya Garciab1262a32017-10-25 09:51:14 +01002071
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002072/**
2073 * Uncomment the macro to let Mbed TLS use your alternate implementation of
Hanno Becker6a739782018-09-05 15:06:19 +01002074 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002075 * platform_util.c.
2076 *
Hanno Becker921b76d2018-09-05 16:21:36 +01002077 * gmtime() is not a thread-safe function as defined in the C standard. The
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002078 * library will try to use safer implementations of this function, such as
2079 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
Hanno Becker6a739782018-09-05 15:06:19 +01002080 * system, the implementation of mbedtls_platform_gmtime_r() will default to
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002081 * using the standard gmtime(). In this case, calls from the library to
2082 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
Hanno Becker9fbbf1c2018-09-05 16:23:02 +01002083 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002084 * library are also guarded with this mutex to avoid race conditions. However,
Hanno Becker6a739782018-09-05 15:06:19 +01002085 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
2086 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
2087 * supplied at compile time.
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002088 */
Hanno Becker6a739782018-09-05 15:06:19 +01002089//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
Andres Amaya Garcia1abb3682018-08-16 21:42:09 +01002090
Christoph M. Wintersteigerc3cbdde2018-12-14 11:03:02 +00002091/**
Christoph M. Wintersteiger5833de72019-02-15 12:49:27 +00002092 * Enable the verified implementations of ECDH primitives from Project Everest
2093 * (currently only Curve25519). This feature changes the layout of ECDH
2094 * contexts and therefore is a compatibility break for applications that access
2095 * fields of a mbedtls_ecdh_context structure directly. See also
2096 * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h.
Christoph M. Wintersteigerde4fcf22018-10-25 12:41:04 +01002097 */
Christoph M. Wintersteiger78450a32019-01-17 12:17:54 +00002098//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
Christoph M. Wintersteigerde4fcf22018-10-25 12:41:04 +01002099
2100/* \} name SECTION: Customisation configuration options */
2101
Simon Butcher3ad2efd2018-05-02 14:49:38 +01002102/* Target and application specific configurations
2103 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002104 * Allow user to override any previous default.
2105 *
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002106 */
Simon Butcher3ad2efd2018-05-02 14:49:38 +01002107#if defined(MBEDTLS_USER_CONFIG_FILE)
Manuel Pégourié-Gonnard32da9f62015-07-31 15:52:30 +02002108#include MBEDTLS_USER_CONFIG_FILE
2109#endif
2110
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +01002111#include "mbedtls/check_config.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01002112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113#endif /* MBEDTLS_CONFIG_H */