blob: 97a1b2b68200114a0e1dad621872f925eeb5d9c4 [file] [log] [blame]
Gilles Peskined8374ba2018-02-16 20:36:55 +01001/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00002 * \file config.h
Gilles Peskined8374ba2018-02-16 20:36:55 +01003 *
Jaeden Amero06b161a2019-02-08 16:07:52 +00004 * \brief Configuration options (set of defines)
Gilles Peskined8374ba2018-02-16 20:36:55 +01005 *
Jaeden Amero06b161a2019-02-08 16:07:52 +00006 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
Gilles Peskined8374ba2018-02-16 20:36:55 +01009 */
10/*
11 * Copyright (C) 2006-2018, ARM Limited, All Rights Reserved
12 * 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.
25 *
26 * This file is part of mbed TLS (https://tls.mbed.org)
27 */
28
29#ifndef MBEDTLS_CONFIG_H
30#define MBEDTLS_CONFIG_H
31
32#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE)
33#define _CRT_SECURE_NO_DEPRECATE 1
34#endif
35
36/**
37 * \name SECTION: System support
38 *
39 * This section sets system specific settings.
40 * \{
41 */
42
43/**
44 * \def MBEDTLS_HAVE_ASM
45 *
46 * The compiler has support for asm().
47 *
48 * Requires support for asm() in compiler.
49 *
50 * Used in:
Jaeden Amero06b161a2019-02-08 16:07:52 +000051 * library/aria.c
Gilles Peskined8374ba2018-02-16 20:36:55 +010052 * library/timing.c
Gilles Peskined8374ba2018-02-16 20:36:55 +010053 * include/mbedtls/bn_mul.h
54 *
Jaeden Amero06b161a2019-02-08 16:07:52 +000055 * Required by:
56 * MBEDTLS_AESNI_C
57 * MBEDTLS_PADLOCK_C
58 *
Gilles Peskined8374ba2018-02-16 20:36:55 +010059 * Comment to disable the use of assembly code.
60 */
61#define MBEDTLS_HAVE_ASM
62
63/**
64 * \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
84 * 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.
88 */
89//#define MBEDTLS_NO_UDBL_DIVISION
90
91/**
Jaeden Amero06b161a2019-02-08 16:07:52 +000092 * \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/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100114 * \def MBEDTLS_HAVE_SSE2
115 *
116 * CPU supports SSE2 instruction set.
117 *
118 * Uncomment if the CPU supports SSE2 (IA-32 specific).
119 */
120//#define MBEDTLS_HAVE_SSE2
121
122/**
Jaeden Amero06b161a2019-02-08 16:07:52 +0000123 * \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 *
140 * System has time.h, time(), and an implementation for
141 * mbedtls_platform_gmtime_r() (see below).
142 * The time needs to be correct (not necessarily very accurate, but at least
143 * 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.
147 *
148 * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that
149 * behaves similarly to the gmtime_r() function from the C standard. Refer to
150 * the documentation for mbedtls_platform_gmtime_r() for more information.
151 *
152 * \note It is possible to configure an implementation for
153 * mbedtls_platform_gmtime_r() at compile-time by using the macro
154 * MBEDTLS_PLATFORM_GMTIME_R_ALT.
155 */
156#define MBEDTLS_HAVE_TIME_DATE
157
158/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100159 * \def MBEDTLS_PLATFORM_MEMORY
160 *
161 * Enable the memory allocation layer.
162 *
163 * By default mbed TLS uses the system-provided calloc() and free().
164 * This allows different allocators (self-implemented or provided) to be
165 * provided to the platform abstraction layer.
166 *
167 * Enabling MBEDTLS_PLATFORM_MEMORY without the
168 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide
169 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and
170 * free() function pointer at runtime.
171 *
172 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying
173 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the
174 * alternate function at compile time.
175 *
176 * Requires: MBEDTLS_PLATFORM_C
177 *
178 * Enable this layer to allow use of alternative memory allocators.
179 */
180//#define MBEDTLS_PLATFORM_MEMORY
181
182/**
183 * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
184 *
185 * 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)
187 *
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
191 * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a
192 * MBEDTLS_PLATFORM_XXX_MACRO.
193 *
194 * Requires: MBEDTLS_PLATFORM_C
195 *
196 * Uncomment to prevent default assignment of standard functions in the
197 * platform layer.
198 */
199//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
200
201/**
202 * \def MBEDTLS_PLATFORM_EXIT_ALT
203 *
204 * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let mbed TLS support the
205 * function in the platform abstraction layer.
206 *
207 * 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
209 * alternative printf function pointer.
210 *
211 * All these define require MBEDTLS_PLATFORM_C to be defined!
212 *
213 * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows;
214 * it will be enabled automatically by check_config.h
215 *
216 * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as
217 * MBEDTLS_PLATFORM_XXX_MACRO!
218 *
Jaeden Amero06b161a2019-02-08 16:07:52 +0000219 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
220 *
Gilles Peskined8374ba2018-02-16 20:36:55 +0100221 * Uncomment a macro to enable alternate implementation of specific base
222 * platform function
223 */
224//#define MBEDTLS_PLATFORM_EXIT_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000225//#define MBEDTLS_PLATFORM_TIME_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100226//#define MBEDTLS_PLATFORM_FPRINTF_ALT
227//#define MBEDTLS_PLATFORM_PRINTF_ALT
228//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000229//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100230//#define MBEDTLS_PLATFORM_NV_SEED_ALT
231//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
232
233/**
234 * \def MBEDTLS_DEPRECATED_WARNING
235 *
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
242 * use MBEDTLS_DEPRECATED_REMOVED
243 *
244 * Uncomment to get warnings on using deprecated functions.
245 */
246//#define MBEDTLS_DEPRECATED_WARNING
247
248/**
249 * \def MBEDTLS_DEPRECATED_REMOVED
250 *
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 */
258//#define MBEDTLS_DEPRECATED_REMOVED
259
Jaeden Amero06b161a2019-02-08 16:07:52 +0000260/**
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:
280 * - the pointer is checked to be non-NULL only if this option is enabled
281 * - the content of the buffer is always validated
282 *
283 * When this flag is defined, if a library function receives a parameter that
284 * is invalid, it will:
285 * - invoke the macro MBEDTLS_PARAM_FAILED() which by default expands to a
286 * call to the function mbedtls_param_failed()
287 * - immediately return (with a specific error code unless the function
288 * returns void and can't communicate an error).
289 *
290 * When defining this flag, you also need to:
291 * - either provide a definition of the function mbedtls_param_failed() in
292 * your application (see platform_util.h for its prototype) as the library
293 * calls that function, but does not provide a default definition for it,
294 * - or provide a different definition of the macro MBEDTLS_PARAM_FAILED()
295 * below if the above mechanism is not flexible enough to suit your needs.
296 * See the documentation of this macro later in this file.
297 *
298 * Uncomment to enable validation of application-controlled parameters.
299 */
300//#define MBEDTLS_CHECK_PARAMS
301
Gilles Peskined8374ba2018-02-16 20:36:55 +0100302/* \} name SECTION: System support */
303
304/**
305 * \name SECTION: mbed TLS feature support
306 *
307 * This section sets support for features that are or are not needed
308 * within the modules that are enabled.
309 * \{
310 */
311
312/**
Jaeden Amero06b161a2019-02-08 16:07:52 +0000313 * \def MBEDTLS_TIMING_ALT
314 *
315 * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(),
316 * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay()
317 *
318 * Only works if you have MBEDTLS_TIMING_C enabled.
319 *
320 * You will need to provide a header "timing_alt.h" and an implementation at
321 * compile time.
322 */
323//#define MBEDTLS_TIMING_ALT
324
325/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100326 * \def MBEDTLS_AES_ALT
327 *
328 * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let mbed TLS use your
329 * alternate core implementation of a symmetric crypto, an arithmetic or hash
330 * module (e.g. platform specific assembly optimized implementations). Keep
331 * in mind that the function prototypes should remain the same.
332 *
333 * This replaces the whole module. If you only want to replace one of the
334 * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags.
335 *
336 * Example: In case you uncomment MBEDTLS_AES_ALT, mbed TLS will no longer
337 * provide the "struct mbedtls_aes_context" definition and omit the base
338 * function declarations and implementations. "aes_alt.h" will be included from
339 * "aes.h" to include the new function definitions.
340 *
341 * Uncomment a macro to enable alternate implementation of the corresponding
342 * module.
343 *
344 * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their
345 * use constitutes a security risk. If possible, we recommend
346 * avoiding dependencies on them, and considering stronger message
347 * digests and ciphers instead.
348 *
349 */
350//#define MBEDTLS_AES_ALT
351//#define MBEDTLS_ARC4_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000352//#define MBEDTLS_ARIA_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100353//#define MBEDTLS_BLOWFISH_ALT
354//#define MBEDTLS_CAMELLIA_ALT
355//#define MBEDTLS_CCM_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000356//#define MBEDTLS_CHACHA20_ALT
357//#define MBEDTLS_CHACHAPOLY_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100358//#define MBEDTLS_CMAC_ALT
359//#define MBEDTLS_DES_ALT
360//#define MBEDTLS_DHM_ALT
361//#define MBEDTLS_ECJPAKE_ALT
362//#define MBEDTLS_GCM_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000363//#define MBEDTLS_NIST_KW_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100364//#define MBEDTLS_MD2_ALT
365//#define MBEDTLS_MD4_ALT
366//#define MBEDTLS_MD5_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000367//#define MBEDTLS_POLY1305_ALT
Gilles Peskined8374ba2018-02-16 20:36:55 +0100368//#define MBEDTLS_RIPEMD160_ALT
369//#define MBEDTLS_RSA_ALT
370//#define MBEDTLS_SHA1_ALT
371//#define MBEDTLS_SHA256_ALT
372//#define MBEDTLS_SHA512_ALT
373//#define MBEDTLS_XTEA_ALT
Jaeden Amero06b161a2019-02-08 16:07:52 +0000374
Gilles Peskined8374ba2018-02-16 20:36:55 +0100375/*
376 * When replacing the elliptic curve module, pleace consider, that it is
377 * implemented with two .c files:
378 * - ecp.c
379 * - ecp_curves.c
380 * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT
381 * macros as described above. The only difference is that you have to make sure
382 * that you provide functionality for both .c files.
383 */
384//#define MBEDTLS_ECP_ALT
385
386/**
387 * \def MBEDTLS_MD2_PROCESS_ALT
388 *
389 * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use you
390 * alternate core implementation of symmetric crypto or hash function. Keep in
391 * mind that function prototypes should remain the same.
392 *
393 * This replaces only one function. The header file from mbed TLS is still
394 * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags.
395 *
396 * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, mbed TLS will
397 * no longer provide the mbedtls_sha1_process() function, but it will still provide
398 * the other function (using your mbedtls_sha1_process() function) and the definition
399 * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible
400 * with this definition.
401 *
402 * \note Because of a signature change, the core AES encryption and decryption routines are
403 * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt,
404 * respectively. When setting up alternative implementations, these functions should
Jaeden Amero06b161a2019-02-08 16:07:52 +0000405 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
Gilles Peskined8374ba2018-02-16 20:36:55 +0100406 * must stay untouched.
407 *
408 * \note If you use the AES_xxx_ALT macros, then is is recommended to also set
409 * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES
410 * tables.
411 *
412 * Uncomment a macro to enable alternate implementation of the corresponding
413 * function.
414 *
415 * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use
416 * constitutes a security risk. If possible, we recommend avoiding
417 * dependencies on them, and considering stronger message digests
418 * and ciphers instead.
419 *
420 */
421//#define MBEDTLS_MD2_PROCESS_ALT
422//#define MBEDTLS_MD4_PROCESS_ALT
423//#define MBEDTLS_MD5_PROCESS_ALT
424//#define MBEDTLS_RIPEMD160_PROCESS_ALT
425//#define MBEDTLS_SHA1_PROCESS_ALT
426//#define MBEDTLS_SHA256_PROCESS_ALT
427//#define MBEDTLS_SHA512_PROCESS_ALT
428//#define MBEDTLS_DES_SETKEY_ALT
429//#define MBEDTLS_DES_CRYPT_ECB_ALT
430//#define MBEDTLS_DES3_CRYPT_ECB_ALT
431//#define MBEDTLS_AES_SETKEY_ENC_ALT
432//#define MBEDTLS_AES_SETKEY_DEC_ALT
433//#define MBEDTLS_AES_ENCRYPT_ALT
434//#define MBEDTLS_AES_DECRYPT_ALT
435//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT
436//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT
437//#define MBEDTLS_ECDSA_VERIFY_ALT
438//#define MBEDTLS_ECDSA_SIGN_ALT
439//#define MBEDTLS_ECDSA_GENKEY_ALT
440
441/**
442 * \def MBEDTLS_ECP_INTERNAL_ALT
443 *
444 * Expose a part of the internal interface of the Elliptic Curve Point module.
445 *
446 * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let mbed TLS use your
447 * alternative core implementation of elliptic curve arithmetic. Keep in mind
448 * that function prototypes should remain the same.
449 *
450 * This partially replaces one function. The header file from mbed TLS is still
451 * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation
452 * is still present and it is used for group structures not supported by the
453 * alternative.
454 *
455 * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT
456 * and implementing the following functions:
457 * unsigned char mbedtls_internal_ecp_grp_capable(
458 * const mbedtls_ecp_group *grp )
459 * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp )
Jaeden Amero06b161a2019-02-08 16:07:52 +0000460 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
Gilles Peskined8374ba2018-02-16 20:36:55 +0100461 * The mbedtls_internal_ecp_grp_capable function should return 1 if the
462 * replacement functions implement arithmetic for the given group and 0
463 * otherwise.
Jaeden Amero06b161a2019-02-08 16:07:52 +0000464 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
Gilles Peskined8374ba2018-02-16 20:36:55 +0100465 * called before and after each point operation and provide an opportunity to
466 * implement optimized set up and tear down instructions.
467 *
468 * Example: In case you uncomment MBEDTLS_ECP_INTERNAL_ALT and
469 * MBEDTLS_ECP_DOUBLE_JAC_ALT, mbed TLS will still provide the ecp_double_jac
470 * function, but will use your mbedtls_internal_ecp_double_jac if the group is
471 * supported (your mbedtls_internal_ecp_grp_capable function returns 1 when
472 * receives it as an argument). If the group is not supported then the original
473 * implementation is used. The other functions and the definition of
474 * mbedtls_ecp_group and mbedtls_ecp_point will not change, so your
475 * implementation of mbedtls_internal_ecp_double_jac and
476 * mbedtls_internal_ecp_grp_capable must be compatible with this definition.
477 *
478 * Uncomment a macro to enable alternate implementation of the corresponding
479 * function.
480 */
481/* Required for all the functions in this section */
482//#define MBEDTLS_ECP_INTERNAL_ALT
483/* Support for Weierstrass curves with Jacobi representation */
484//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT
485//#define MBEDTLS_ECP_ADD_MIXED_ALT
486//#define MBEDTLS_ECP_DOUBLE_JAC_ALT
487//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT
488//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT
489/* Support for curves with Montgomery arithmetic */
490//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT
491//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT
492//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT
493
494/**
495 * \def MBEDTLS_TEST_NULL_ENTROPY
496 *
497 * Enables testing and use of mbed TLS without any configured entropy sources.
498 * This permits use of the library on platforms before an entropy source has
499 * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the
500 * MBEDTLS_ENTROPY_NV_SEED switches).
501 *
502 * WARNING! This switch MUST be disabled in production builds, and is suitable
503 * only for development.
504 * Enabling the switch negates any security provided by the library.
505 *
506 * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
507 *
508 */
509//#define MBEDTLS_TEST_NULL_ENTROPY
510
511/**
512 * \def MBEDTLS_ENTROPY_HARDWARE_ALT
513 *
514 * Uncomment this macro to let mbed TLS use your own implementation of a
515 * hardware entropy collector.
516 *
517 * Your function must be called \c mbedtls_hardware_poll(), have the same
518 * prototype as declared in entropy_poll.h, and accept NULL as first argument.
519 *
520 * Uncomment to use your own hardware entropy collector.
521 */
522//#define MBEDTLS_ENTROPY_HARDWARE_ALT
523
524/**
525 * \def MBEDTLS_AES_ROM_TABLES
526 *
Gilles Peskine13187932018-06-19 11:49:23 +0200527 * Use precomputed AES tables stored in ROM.
Gilles Peskined8374ba2018-02-16 20:36:55 +0100528 *
Gilles Peskine13187932018-06-19 11:49:23 +0200529 * Uncomment this macro to use precomputed AES tables stored in ROM.
530 * Comment this macro to generate AES tables in RAM at runtime.
531 *
532 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb
533 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the
534 * initialization time before the first AES operation can be performed.
535 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c
536 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded
537 * performance if ROM access is slower than RAM access.
538 *
539 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES.
540 *
Gilles Peskined8374ba2018-02-16 20:36:55 +0100541 */
542//#define MBEDTLS_AES_ROM_TABLES
543
544/**
Gilles Peskine13187932018-06-19 11:49:23 +0200545 * \def MBEDTLS_AES_FEWER_TABLES
546 *
547 * Use less ROM/RAM for AES tables.
548 *
549 * Uncommenting this macro omits 75% of the AES tables from
550 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES)
551 * by computing their values on the fly during operations
552 * (the tables are entry-wise rotations of one another).
553 *
554 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint
555 * by ~6kb but at the cost of more arithmetic operations during
556 * runtime. Specifically, one has to compare 4 accesses within
557 * different tables to 4 accesses with additional arithmetic
558 * operations within the same table. The performance gain/loss
559 * depends on the system and memory details.
560 *
561 * This option is independent of \c MBEDTLS_AES_ROM_TABLES.
562 *
563 */
564//#define MBEDTLS_AES_FEWER_TABLES
565
566/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100567 * \def MBEDTLS_CAMELLIA_SMALL_MEMORY
568 *
569 * Use less ROM for the Camellia implementation (saves about 768 bytes).
570 *
571 * Uncomment this macro to use less memory for Camellia.
572 */
573//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
574
575/**
576 * \def MBEDTLS_CIPHER_MODE_CBC
577 *
578 * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers.
579 */
580#define MBEDTLS_CIPHER_MODE_CBC
581
582/**
583 * \def MBEDTLS_CIPHER_MODE_CFB
584 *
585 * Enable Cipher Feedback mode (CFB) for symmetric ciphers.
586 */
587#define MBEDTLS_CIPHER_MODE_CFB
588
589/**
590 * \def MBEDTLS_CIPHER_MODE_CTR
591 *
592 * Enable Counter Block Cipher mode (CTR) for symmetric ciphers.
593 */
594#define MBEDTLS_CIPHER_MODE_CTR
595
596/**
Jaeden Amero06b161a2019-02-08 16:07:52 +0000597 * \def MBEDTLS_CIPHER_MODE_OFB
598 *
599 * Enable Output Feedback mode (OFB) for symmetric ciphers.
600 */
601#define MBEDTLS_CIPHER_MODE_OFB
602
603/**
604 * \def MBEDTLS_CIPHER_MODE_XTS
605 *
606 * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES.
607 */
608#define MBEDTLS_CIPHER_MODE_XTS
609
610/**
611 * \def MBEDTLS_CIPHER_NULL_CIPHER
612 *
613 * Enable NULL cipher.
614 * Warning: Only do so when you know what you are doing. This allows for
615 * encryption or channels without any security!
616 *
Jaeden Amero7242ea62019-04-10 18:00:15 +0100617 * This module is required to support the TLS ciphersuites that use the NULL
618 * cipher.
Jaeden Amero06b161a2019-02-08 16:07:52 +0000619 *
Jaeden Amero1c66e482018-11-02 18:15:18 +0000620 * Uncomment this macro to enable the NULL cipher
Jaeden Amero06b161a2019-02-08 16:07:52 +0000621 */
622//#define MBEDTLS_CIPHER_NULL_CIPHER
623
624/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100625 * \def MBEDTLS_CIPHER_PADDING_PKCS7
626 *
627 * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for
628 * specific padding modes in the cipher layer with cipher modes that support
629 * padding (e.g. CBC)
630 *
631 * If you disable all padding modes, only full blocks can be used with CBC.
632 *
633 * Enable padding modes in the cipher layer.
634 */
635#define MBEDTLS_CIPHER_PADDING_PKCS7
636#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
637#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
638#define MBEDTLS_CIPHER_PADDING_ZEROS
639
640/**
641 * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED
642 *
643 * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve
644 * module. By default all supported curves are enabled.
645 *
646 * Comment macros to disable the curve and functions for it
647 */
648#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
649#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
650#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
651#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
652#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
653#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
654#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
655#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
656#define MBEDTLS_ECP_DP_BP256R1_ENABLED
657#define MBEDTLS_ECP_DP_BP384R1_ENABLED
658#define MBEDTLS_ECP_DP_BP512R1_ENABLED
659#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
Gilles Peskine13187932018-06-19 11:49:23 +0200660#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Gilles Peskined8374ba2018-02-16 20:36:55 +0100661
662/**
663 * \def MBEDTLS_ECP_NIST_OPTIM
664 *
665 * Enable specific 'modulo p' routines for each NIST prime.
666 * Depending on the prime and architecture, makes operations 4 to 8 times
667 * faster on the corresponding curve.
668 *
669 * Comment this macro to disable NIST curves optimisation.
670 */
671#define MBEDTLS_ECP_NIST_OPTIM
672
673/**
Jaeden Amero06b161a2019-02-08 16:07:52 +0000674 * \def MBEDTLS_ECP_RESTARTABLE
675 *
676 * Enable "non-blocking" ECC operations that can return early and be resumed.
677 *
678 * This allows various functions to pause by returning
Jaeden Amerode0a41b2018-11-02 18:40:14 +0000679 * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in Mbed TLS's SSL module,
680 * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in order
681 * to further progress and eventually complete their operation. This is
682 * controlled through mbedtls_ecp_set_max_ops() which limits the maximum number
683 * of ECC operations a function may perform before pausing; see
Jaeden Amero06b161a2019-02-08 16:07:52 +0000684 * mbedtls_ecp_set_max_ops() for more information.
685 *
686 * This is useful in non-threaded environments if you want to avoid blocking
687 * for too long on ECC (and, hence, X.509 or SSL/TLS) operations.
688 *
689 * Uncomment this macro to enable restartable ECC computations.
690 *
691 * \note This option only works with the default software implementation of
692 * elliptic curve functionality. It is incompatible with
693 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT and MBEDTLS_ECDSA_XXX_ALT.
694 */
695//#define MBEDTLS_ECP_RESTARTABLE
696
697/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100698 * \def MBEDTLS_ECDSA_DETERMINISTIC
699 *
700 * Enable deterministic ECDSA (RFC 6979).
701 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
702 * may result in a compromise of the long-term signing key. This is avoided by
703 * the deterministic variant.
704 *
705 * Requires: MBEDTLS_HMAC_DRBG_C
706 *
707 * Comment this macro to disable deterministic ECDSA.
708 */
709#define MBEDTLS_ECDSA_DETERMINISTIC
710
711/**
712 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
713 *
714 * Enhance support for reading EC keys using variants of SEC1 not allowed by
715 * RFC 5915 and RFC 5480.
716 *
717 * Currently this means parsing the SpecifiedECDomain choice of EC
718 * parameters (only known groups are supported, not arbitrary domains, to
719 * avoid validation issues).
720 *
721 * Disable if you only need to support RFC 5915 + 5480 key formats.
722 */
723#define MBEDTLS_PK_PARSE_EC_EXTENDED
724
725/**
726 * \def MBEDTLS_ERROR_STRERROR_DUMMY
727 *
728 * Enable a dummy error function to make use of mbedtls_strerror() in
729 * third party libraries easier when MBEDTLS_ERROR_C is disabled
730 * (no effect when MBEDTLS_ERROR_C is enabled).
731 *
732 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
733 * not using mbedtls_strerror() or error_strerror() in your application.
734 *
735 * Disable if you run into name conflicts and want to really remove the
736 * mbedtls_strerror()
737 */
738#define MBEDTLS_ERROR_STRERROR_DUMMY
739
740/**
741 * \def MBEDTLS_GENPRIME
742 *
743 * Enable the prime-number generation code.
744 *
745 * Requires: MBEDTLS_BIGNUM_C
746 */
747#define MBEDTLS_GENPRIME
748
749/**
750 * \def MBEDTLS_FS_IO
751 *
752 * Enable functions that use the filesystem.
753 */
754#define MBEDTLS_FS_IO
755
756/**
757 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
758 *
759 * Do not add default entropy sources. These are the platform specific,
760 * mbedtls_timing_hardclock and HAVEGE based poll functions.
761 *
762 * This is useful to have more control over the added entropy sources in an
763 * application.
764 *
765 * Uncomment this macro to prevent loading of default entropy functions.
766 */
767//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
768
769/**
770 * \def MBEDTLS_NO_PLATFORM_ENTROPY
771 *
772 * Do not use built-in platform entropy functions.
773 * This is useful if your platform does not support
774 * standards like the /dev/urandom or Windows CryptoAPI.
775 *
776 * Uncomment this macro to disable the built-in platform entropy functions.
777 */
778//#define MBEDTLS_NO_PLATFORM_ENTROPY
779
780/**
781 * \def MBEDTLS_ENTROPY_FORCE_SHA256
782 *
783 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
784 * default SHA-512 based one (if both are available).
785 *
786 * Requires: MBEDTLS_SHA256_C
787 *
788 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
789 * if you have performance concerns.
790 *
791 * This option is only useful if both MBEDTLS_SHA256_C and
792 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
793 */
794//#define MBEDTLS_ENTROPY_FORCE_SHA256
795
796/**
797 * \def MBEDTLS_ENTROPY_NV_SEED
798 *
799 * Enable the non-volatile (NV) seed file-based entropy source.
800 * (Also enables the NV seed read/write functions in the platform layer)
801 *
802 * This is crucial (if not required) on systems that do not have a
803 * cryptographic entropy source (in hardware or kernel) available.
804 *
805 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
806 *
807 * \note The read/write functions that are used by the entropy source are
808 * determined in the platform layer, and can be modified at runtime and/or
809 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
810 *
811 * \note If you use the default implementation functions that read a seedfile
812 * with regular fopen(), please make sure you make a seedfile with the
813 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
814 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
815 * and written to or you will get an entropy source error! The default
816 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
817 * bytes from the file.
818 *
819 * \note The entropy collector will write to the seed file before entropy is
820 * given to an external source, to update it.
821 */
822//#define MBEDTLS_ENTROPY_NV_SEED
823
Jaeden Amerobce557d2019-02-22 16:34:57 +0000824/* MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
825 *
826 * In PSA key storage, encode the owner of the key.
827 *
828 * This is only meaningful when building the library as part of a
829 * multi-client service. When you activate this option, you must provide
830 * an implementation of the type psa_key_owner_id_t and a translation
831 * from psa_key_file_id_t to file name in all the storage backends that
832 * you wish to support.
833 *
834 * Note that this option is meant for internal use only and may be removed
835 * without notice.
836 */
837//#define MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
838
Jaeden Amero06b161a2019-02-08 16:07:52 +0000839/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100840 * \def MBEDTLS_MEMORY_DEBUG
841 *
842 * Enable debugging of buffer allocator memory issues. Automatically prints
843 * (to stderr) all (fatal) messages on memory allocation issues. Enables
844 * function for 'debug output' of allocated memory.
845 *
846 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
847 *
848 * Uncomment this macro to let the buffer allocator print out error messages.
849 */
850//#define MBEDTLS_MEMORY_DEBUG
851
852/**
853 * \def MBEDTLS_MEMORY_BACKTRACE
854 *
855 * Include backtrace information with each allocated block.
856 *
857 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
858 * GLIBC-compatible backtrace() an backtrace_symbols() support
859 *
860 * Uncomment this macro to include backtrace information
861 */
862//#define MBEDTLS_MEMORY_BACKTRACE
863
864/**
865 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
866 *
867 * Support external private RSA keys (eg from a HSM) in the PK layer.
868 *
869 * Comment this macro to disable support for external private RSA keys.
870 */
871#define MBEDTLS_PK_RSA_ALT_SUPPORT
872
873/**
874 * \def MBEDTLS_PKCS1_V15
875 *
876 * Enable support for PKCS#1 v1.5 encoding.
877 *
878 * Requires: MBEDTLS_RSA_C
879 *
880 * This enables support for PKCS#1 v1.5 operations.
881 */
882#define MBEDTLS_PKCS1_V15
883
884/**
885 * \def MBEDTLS_PKCS1_V21
886 *
887 * Enable support for PKCS#1 v2.1 encoding.
888 *
889 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
890 *
891 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
892 */
893#define MBEDTLS_PKCS1_V21
894
895/**
Jaeden Amero67a93512018-07-11 16:07:40 +0100896 * \def MBEDTLS_PSA_CRYPTO_SPM
897 *
898 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
899 * Partition Manager) integration which separates the code into two parts: a
900 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
901 * Environment).
902 *
903 * Module: library/psa_crypto.c
904 * Requires: MBEDTLS_PSA_CRYPTO_C
905 *
906 */
907//#define MBEDTLS_PSA_CRYPTO_SPM
908
909/**
Gilles Peskinee3dbdd82019-02-25 11:04:06 +0100910 * \def MBEDTLS_PSA_INJECT_ENTROPY
911 *
912 * Enable support for entropy injection at first boot. This feature is
913 * required on systems that do not have a built-in entropy source (TRNG).
914 * This feature is currently not supported on systems that have a built-in
915 * entropy source.
916 *
917 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
918 *
919 */
920//#define MBEDTLS_PSA_INJECT_ENTROPY
921
922/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100923 * \def MBEDTLS_RSA_NO_CRT
924 *
Jaeden Amero06b161a2019-02-08 16:07:52 +0000925 * Do not use the Chinese Remainder Theorem
926 * for the RSA private operation.
Gilles Peskined8374ba2018-02-16 20:36:55 +0100927 *
928 * Uncomment this macro to disable the use of CRT in RSA.
929 *
930 */
931//#define MBEDTLS_RSA_NO_CRT
932
933/**
934 * \def MBEDTLS_SELF_TEST
935 *
936 * Enable the checkup functions (*_self_test).
937 */
938#define MBEDTLS_SELF_TEST
939
940/**
941 * \def MBEDTLS_SHA256_SMALLER
942 *
943 * Enable an implementation of SHA-256 that has lower ROM footprint but also
944 * lower performance.
945 *
946 * The default implementation is meant to be a reasonnable compromise between
947 * performance and size. This version optimizes more aggressively for size at
948 * the expense of performance. Eg on Cortex-M4 it reduces the size of
949 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
950 * 30%.
951 *
952 * Uncomment to enable the smaller implementation of SHA256.
953 */
954//#define MBEDTLS_SHA256_SMALLER
955
956/**
957 * \def MBEDTLS_THREADING_ALT
958 *
959 * Provide your own alternate threading implementation.
960 *
961 * Requires: MBEDTLS_THREADING_C
962 *
963 * Uncomment this to allow your own alternate threading implementation.
964 */
965//#define MBEDTLS_THREADING_ALT
966
967/**
968 * \def MBEDTLS_THREADING_PTHREAD
969 *
970 * Enable the pthread wrapper layer for the threading layer.
971 *
972 * Requires: MBEDTLS_THREADING_C
973 *
974 * Uncomment this to enable pthread mutexes.
975 */
976//#define MBEDTLS_THREADING_PTHREAD
977
978/**
Jaeden Amero06b161a2019-02-08 16:07:52 +0000979 * \def MBEDTLS_USE_PSA_CRYPTO
980 *
981 * Make the X.509 and TLS library use PSA for cryptographic operations, see
982 * #MBEDTLS_PSA_CRYPTO_C.
983 *
984 * Note: this option is still in progress, the full X.509 and TLS modules are
985 * not covered yet, but parts that are not ported to PSA yet will still work
986 * as usual, so enabling this option should not break backwards compatibility.
987 *
988 * \warning Support for PSA is still an experimental feature.
989 * Any public API that depends on this option may change
990 * at any time until this warning is removed.
991 *
992 * Requires: MBEDTLS_PSA_CRYPTO_C.
993 */
994//#define MBEDTLS_USE_PSA_CRYPTO
995
996/**
Gilles Peskined8374ba2018-02-16 20:36:55 +0100997 * \def MBEDTLS_VERSION_FEATURES
998 *
999 * Allow run-time checking of compile-time enabled features. Thus allowing users
1000 * to check at run-time if the library is for instance compiled with threading
1001 * support via mbedtls_version_check_feature().
1002 *
1003 * Requires: MBEDTLS_VERSION_C
1004 *
1005 * Comment this to disable run-time checking and save ROM space
1006 */
1007#define MBEDTLS_VERSION_FEATURES
1008
1009/* \} name SECTION: mbed TLS feature support */
1010
1011/**
1012 * \name SECTION: mbed TLS modules
1013 *
1014 * This section enables or disables entire modules in mbed TLS
1015 * \{
1016 */
1017
1018/**
1019 * \def MBEDTLS_AESNI_C
1020 *
1021 * Enable AES-NI support on x86-64.
1022 *
1023 * Module: library/aesni.c
1024 * Caller: library/aes.c
1025 *
1026 * Requires: MBEDTLS_HAVE_ASM
1027 *
1028 * This modules adds support for the AES-NI instructions on x86-64
1029 */
1030#define MBEDTLS_AESNI_C
1031
1032/**
1033 * \def MBEDTLS_AES_C
1034 *
1035 * Enable the AES block cipher.
1036 *
1037 * Module: library/aes.c
Jaeden Amero06b161a2019-02-08 16:07:52 +00001038 * Caller: library/cipher.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001039 * library/pem.c
1040 * library/ctr_drbg.c
1041 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001042 * This module is required to support the TLS ciphersuites that use the AES
1043 * cipher.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001044 *
1045 * PEM_PARSE uses AES for decrypting encrypted keys.
1046 */
1047#define MBEDTLS_AES_C
1048
1049/**
1050 * \def MBEDTLS_ARC4_C
1051 *
1052 * Enable the ARCFOUR stream cipher.
1053 *
1054 * Module: library/arc4.c
Jaeden Amero06b161a2019-02-08 16:07:52 +00001055 * Caller: library/cipher.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001056 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001057 * This module is required to support the TLS ciphersuites that use the ARC4
1058 * cipher.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001059 *
1060 * \warning ARC4 is considered a weak cipher and its use constitutes a
1061 * security risk. If possible, we recommend avoidng dependencies on
1062 * it, and considering stronger ciphers instead.
1063 *
1064 */
1065#define MBEDTLS_ARC4_C
1066
1067/**
1068 * \def MBEDTLS_ASN1_PARSE_C
1069 *
1070 * Enable the generic ASN1 parser.
1071 *
1072 * Module: library/asn1.c
Jaeden Amerobb1f7012018-11-02 18:15:18 +00001073 * Caller: library/dhm.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001074 * library/pkcs12.c
1075 * library/pkcs5.c
1076 * library/pkparse.c
1077 */
1078#define MBEDTLS_ASN1_PARSE_C
1079
1080/**
1081 * \def MBEDTLS_ASN1_WRITE_C
1082 *
1083 * Enable the generic ASN1 writer.
1084 *
1085 * Module: library/asn1write.c
1086 * Caller: library/ecdsa.c
1087 * library/pkwrite.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001088 */
1089#define MBEDTLS_ASN1_WRITE_C
1090
1091/**
1092 * \def MBEDTLS_BASE64_C
1093 *
1094 * Enable the Base64 module.
1095 *
1096 * Module: library/base64.c
1097 * Caller: library/pem.c
1098 *
1099 * This module is required for PEM support (required by X.509).
1100 */
1101#define MBEDTLS_BASE64_C
1102
1103/**
1104 * \def MBEDTLS_BIGNUM_C
1105 *
1106 * Enable the multi-precision integer library.
1107 *
1108 * Module: library/bignum.c
1109 * Caller: library/dhm.c
1110 * library/ecp.c
1111 * library/ecdsa.c
1112 * library/rsa.c
1113 * library/rsa_internal.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001114 *
1115 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
1116 */
1117#define MBEDTLS_BIGNUM_C
1118
1119/**
1120 * \def MBEDTLS_BLOWFISH_C
1121 *
1122 * Enable the Blowfish block cipher.
1123 *
1124 * Module: library/blowfish.c
1125 */
1126#define MBEDTLS_BLOWFISH_C
1127
1128/**
1129 * \def MBEDTLS_CAMELLIA_C
1130 *
1131 * Enable the Camellia block cipher.
1132 *
1133 * Module: library/camellia.c
Jaeden Amero06b161a2019-02-08 16:07:52 +00001134 * Caller: library/cipher.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001135 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001136 * This module is required to support the TLS ciphersuites that use the
1137 * Camellia cipher.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001138 */
1139#define MBEDTLS_CAMELLIA_C
1140
1141/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001142 * \def MBEDTLS_ARIA_C
1143 *
1144 * Enable the ARIA block cipher.
1145 *
1146 * Module: library/aria.c
1147 * Caller: library/cipher.c
1148 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001149 * This module is required to support the TLS ciphersuites that use the
1150 * ARIA cipher.
Jaeden Amero06b161a2019-02-08 16:07:52 +00001151 */
1152//#define MBEDTLS_ARIA_C
1153
1154/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001155 * \def MBEDTLS_CCM_C
1156 *
1157 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
1158 *
1159 * Module: library/ccm.c
1160 *
1161 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
1162 *
Jaeden Amero1c66e482018-11-02 18:15:18 +00001163 * This module is required to support AES-CCM ciphersuites in TLS.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001164 */
1165#define MBEDTLS_CCM_C
1166
1167/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001168 * \def MBEDTLS_CHACHA20_C
1169 *
1170 * Enable the ChaCha20 stream cipher.
1171 *
1172 * Module: library/chacha20.c
1173 */
1174#define MBEDTLS_CHACHA20_C
1175
1176/**
1177 * \def MBEDTLS_CHACHAPOLY_C
1178 *
1179 * Enable the ChaCha20-Poly1305 AEAD algorithm.
1180 *
1181 * Module: library/chachapoly.c
1182 *
1183 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
1184 */
1185#define MBEDTLS_CHACHAPOLY_C
1186
1187/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001188 * \def MBEDTLS_CIPHER_C
1189 *
1190 * Enable the generic cipher layer.
1191 *
1192 * Module: library/cipher.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001193 *
1194 * Uncomment to enable generic cipher wrappers.
1195 */
1196#define MBEDTLS_CIPHER_C
1197
1198/**
1199 * \def MBEDTLS_CMAC_C
1200 *
1201 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
1202 * ciphers.
1203 *
1204 * Module: library/cmac.c
1205 *
1206 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
1207 *
1208 */
1209#define MBEDTLS_CMAC_C
1210
1211/**
1212 * \def MBEDTLS_CTR_DRBG_C
1213 *
Jaeden Amero06b161a2019-02-08 16:07:52 +00001214 * Enable the CTR_DRBG AES-based random generator.
1215 * The CTR_DRBG generator uses AES-256 by default.
1216 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001217 *
1218 * Module: library/ctr_drbg.c
1219 * Caller:
1220 *
1221 * Requires: MBEDTLS_AES_C
1222 *
Jaeden Amero06b161a2019-02-08 16:07:52 +00001223 * This module provides the CTR_DRBG AES random number generator.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001224 */
1225#define MBEDTLS_CTR_DRBG_C
1226
1227/**
1228 * \def MBEDTLS_DES_C
1229 *
1230 * Enable the DES block cipher.
1231 *
1232 * Module: library/des.c
1233 * Caller: library/pem.c
Jaeden Amero06b161a2019-02-08 16:07:52 +00001234 * library/cipher.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001235 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001236 * This module is required to support the TLS ciphersuites that use the DES
1237 * cipher.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001238 *
1239 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
1240 *
1241 * \warning DES is considered a weak cipher and its use constitutes a
1242 * security risk. We recommend considering stronger ciphers instead.
1243 */
1244#define MBEDTLS_DES_C
1245
1246/**
1247 * \def MBEDTLS_DHM_C
1248 *
1249 * Enable the Diffie-Hellman-Merkle module.
1250 *
1251 * Module: library/dhm.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001252 *
1253 * This module is used by the following key exchanges:
1254 * DHE-RSA, DHE-PSK
1255 *
1256 * \warning Using DHE constitutes a security risk as it
1257 * is not possible to validate custom DH parameters.
1258 * If possible, it is recommended users should consider
1259 * preferring other methods of key exchange.
1260 * See dhm.h for more details.
1261 *
1262 */
1263#define MBEDTLS_DHM_C
1264
1265/**
1266 * \def MBEDTLS_ECDH_C
1267 *
1268 * Enable the elliptic curve Diffie-Hellman library.
1269 *
1270 * Module: library/ecdh.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001271 *
1272 * This module is used by the following key exchanges:
1273 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
1274 *
1275 * Requires: MBEDTLS_ECP_C
1276 */
1277#define MBEDTLS_ECDH_C
1278
1279/**
1280 * \def MBEDTLS_ECDSA_C
1281 *
1282 * Enable the elliptic curve DSA library.
1283 *
1284 * Module: library/ecdsa.c
1285 * Caller:
1286 *
1287 * This module is used by the following key exchanges:
1288 * ECDHE-ECDSA
1289 *
1290 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
1291 */
1292#define MBEDTLS_ECDSA_C
1293
1294/**
1295 * \def MBEDTLS_ECJPAKE_C
1296 *
1297 * Enable the elliptic curve J-PAKE library.
1298 *
1299 * \warning This is currently experimental. EC J-PAKE support is based on the
1300 * Thread v1.0.0 specification; incompatible changes to the specification
1301 * might still happen. For this reason, this is disabled by default.
1302 *
1303 * Module: library/ecjpake.c
1304 * Caller:
1305 *
1306 * This module is used by the following key exchanges:
1307 * ECJPAKE
1308 *
1309 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
1310 */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001311//#define MBEDTLS_ECJPAKE_C
Gilles Peskined8374ba2018-02-16 20:36:55 +01001312
1313/**
1314 * \def MBEDTLS_ECP_C
1315 *
1316 * Enable the elliptic curve over GF(p) library.
1317 *
1318 * Module: library/ecp.c
1319 * Caller: library/ecdh.c
1320 * library/ecdsa.c
1321 * library/ecjpake.c
1322 *
1323 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
1324 */
1325#define MBEDTLS_ECP_C
1326
1327/**
1328 * \def MBEDTLS_ENTROPY_C
1329 *
1330 * Enable the platform-specific entropy code.
1331 *
1332 * Module: library/entropy.c
1333 * Caller:
1334 *
1335 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
1336 *
1337 * This module provides a generic entropy pool
1338 */
1339#define MBEDTLS_ENTROPY_C
1340
1341/**
1342 * \def MBEDTLS_ERROR_C
1343 *
1344 * Enable error code to error string conversion.
1345 *
1346 * Module: library/error.c
1347 * Caller:
1348 *
1349 * This module enables mbedtls_strerror().
1350 */
1351#define MBEDTLS_ERROR_C
1352
1353/**
1354 * \def MBEDTLS_GCM_C
1355 *
1356 * Enable the Galois/Counter Mode (GCM) for AES.
1357 *
1358 * Module: library/gcm.c
1359 *
1360 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
1361 *
Jaeden Amero7242ea62019-04-10 18:00:15 +01001362 * This module is required to support the TLS ciphersuites that use GCM.
Gilles Peskined8374ba2018-02-16 20:36:55 +01001363 */
1364#define MBEDTLS_GCM_C
1365
1366/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001367 * \def MBEDTLS_HAVEGE_C
1368 *
1369 * Enable the HAVEGE random generator.
1370 *
1371 * Warning: the HAVEGE random generator is not suitable for virtualized
1372 * environments
1373 *
1374 * Warning: the HAVEGE random generator is dependent on timing and specific
1375 * processor traits. It is therefore not advised to use HAVEGE as
1376 * your applications primary random generator or primary entropy pool
1377 * input. As a secondary input to your entropy pool, it IS able add
1378 * the (limited) extra entropy it provides.
1379 *
1380 * Module: library/havege.c
1381 * Caller:
1382 *
1383 * Requires: MBEDTLS_TIMING_C
1384 *
1385 * Uncomment to enable the HAVEGE random generator.
1386 */
1387//#define MBEDTLS_HAVEGE_C
1388
1389/**
1390 * \def MBEDTLS_HKDF_C
1391 *
1392 * Enable the HKDF algorithm (RFC 5869).
1393 *
1394 * Module: library/hkdf.c
1395 * Caller:
1396 *
1397 * Requires: MBEDTLS_MD_C
1398 *
1399 * This module adds support for the Hashed Message Authentication Code
1400 * (HMAC)-based key derivation function (HKDF).
1401 */
1402#define MBEDTLS_HKDF_C
1403
1404/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001405 * \def MBEDTLS_HMAC_DRBG_C
1406 *
1407 * Enable the HMAC_DRBG random generator.
1408 *
1409 * Module: library/hmac_drbg.c
1410 * Caller:
1411 *
1412 * Requires: MBEDTLS_MD_C
1413 *
1414 * Uncomment to enable the HMAC_DRBG random number geerator.
1415 */
1416#define MBEDTLS_HMAC_DRBG_C
1417
1418/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001419 * \def MBEDTLS_NIST_KW_C
1420 *
1421 * Enable the Key Wrapping mode for 128-bit block ciphers,
1422 * as defined in NIST SP 800-38F. Only KW and KWP modes
1423 * are supported. At the moment, only AES is approved by NIST.
1424 *
1425 * Module: library/nist_kw.c
1426 *
1427 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
1428 */
1429//#define MBEDTLS_NIST_KW_C
1430
1431/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001432 * \def MBEDTLS_MD_C
1433 *
1434 * Enable the generic message digest layer.
1435 *
1436 * Module: library/md.c
1437 * Caller:
1438 *
1439 * Uncomment to enable generic message digest wrappers.
1440 */
1441#define MBEDTLS_MD_C
1442
1443/**
1444 * \def MBEDTLS_MD2_C
1445 *
1446 * Enable the MD2 hash algorithm.
1447 *
1448 * Module: library/md2.c
1449 * Caller:
1450 *
1451 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
1452 *
1453 * \warning MD2 is considered a weak message digest and its use constitutes a
1454 * security risk. If possible, we recommend avoiding dependencies on
1455 * it, and considering stronger message digests instead.
1456 *
1457 */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001458//#define MBEDTLS_MD2_C
Gilles Peskined8374ba2018-02-16 20:36:55 +01001459
1460/**
1461 * \def MBEDTLS_MD4_C
1462 *
1463 * Enable the MD4 hash algorithm.
1464 *
1465 * Module: library/md4.c
1466 * Caller:
1467 *
1468 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
1469 *
1470 * \warning MD4 is considered a weak message digest and its use constitutes a
1471 * security risk. If possible, we recommend avoiding dependencies on
1472 * it, and considering stronger message digests instead.
1473 *
1474 */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001475//#define MBEDTLS_MD4_C
Gilles Peskined8374ba2018-02-16 20:36:55 +01001476
1477/**
1478 * \def MBEDTLS_MD5_C
1479 *
1480 * Enable the MD5 hash algorithm.
1481 *
1482 * Module: library/md5.c
1483 * Caller: library/md.c
1484 * library/pem.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001485 *
1486 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
1487 * depending on the handshake parameters. Further, it is used for checking
1488 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
1489 * encrypted keys.
1490 *
1491 * \warning MD5 is considered a weak message digest and its use constitutes a
1492 * security risk. If possible, we recommend avoiding dependencies on
1493 * it, and considering stronger message digests instead.
1494 *
1495 */
1496#define MBEDTLS_MD5_C
1497
1498/**
1499 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
1500 *
1501 * Enable the buffer allocator implementation that makes use of a (stack)
1502 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
1503 * calls)
1504 *
1505 * Module: library/memory_buffer_alloc.c
1506 *
1507 * Requires: MBEDTLS_PLATFORM_C
1508 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
1509 *
1510 * Enable this module to enable the buffer memory allocator.
1511 */
1512//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
1513
1514/**
1515 * \def MBEDTLS_OID_C
1516 *
1517 * Enable the OID database.
1518 *
1519 * Module: library/oid.c
1520 * Caller: library/asn1write.c
1521 * library/pkcs5.c
1522 * library/pkparse.c
1523 * library/pkwrite.c
1524 * library/rsa.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001525 *
1526 * This modules translates between OIDs and internal values.
1527 */
1528#define MBEDTLS_OID_C
1529
1530/**
1531 * \def MBEDTLS_PADLOCK_C
1532 *
1533 * Enable VIA Padlock support on x86.
1534 *
1535 * Module: library/padlock.c
1536 * Caller: library/aes.c
1537 *
1538 * Requires: MBEDTLS_HAVE_ASM
1539 *
1540 * This modules adds support for the VIA PadLock on x86.
1541 */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001542#define MBEDTLS_PADLOCK_C
Gilles Peskined8374ba2018-02-16 20:36:55 +01001543
1544/**
1545 * \def MBEDTLS_PEM_PARSE_C
1546 *
1547 * Enable PEM decoding / parsing.
1548 *
1549 * Module: library/pem.c
1550 * Caller: library/dhm.c
1551 * library/pkparse.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001552 *
1553 * Requires: MBEDTLS_BASE64_C
1554 *
1555 * This modules adds support for decoding / parsing PEM files.
1556 */
1557#define MBEDTLS_PEM_PARSE_C
1558
1559/**
1560 * \def MBEDTLS_PEM_WRITE_C
1561 *
1562 * Enable PEM encoding / writing.
1563 *
1564 * Module: library/pem.c
1565 * Caller: library/pkwrite.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001566 *
1567 * Requires: MBEDTLS_BASE64_C
1568 *
1569 * This modules adds support for encoding / writing PEM files.
1570 */
1571#define MBEDTLS_PEM_WRITE_C
1572
1573/**
1574 * \def MBEDTLS_PK_C
1575 *
1576 * Enable the generic public (asymetric) key layer.
1577 *
1578 * Module: library/pk.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001579 *
1580 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
1581 *
1582 * Uncomment to enable generic public key wrappers.
1583 */
1584#define MBEDTLS_PK_C
1585
1586/**
1587 * \def MBEDTLS_PK_PARSE_C
1588 *
1589 * Enable the generic public (asymetric) key parser.
1590 *
1591 * Module: library/pkparse.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001592 *
1593 * Requires: MBEDTLS_PK_C
1594 *
1595 * Uncomment to enable generic public key parse functions.
1596 */
1597#define MBEDTLS_PK_PARSE_C
1598
1599/**
1600 * \def MBEDTLS_PK_WRITE_C
1601 *
1602 * Enable the generic public (asymetric) key writer.
1603 *
1604 * Module: library/pkwrite.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001605 *
1606 * Requires: MBEDTLS_PK_C
1607 *
1608 * Uncomment to enable generic public key write functions.
1609 */
1610#define MBEDTLS_PK_WRITE_C
1611
1612/**
1613 * \def MBEDTLS_PKCS5_C
1614 *
1615 * Enable PKCS#5 functions.
1616 *
1617 * Module: library/pkcs5.c
1618 *
1619 * Requires: MBEDTLS_MD_C
1620 *
1621 * This module adds support for the PKCS#5 functions.
1622 */
1623#define MBEDTLS_PKCS5_C
1624
1625/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001626 * \def MBEDTLS_PKCS12_C
1627 *
1628 * Enable PKCS#12 PBE functions.
1629 * Adds algorithms for parsing PKCS#8 encrypted private keys
1630 *
1631 * Module: library/pkcs12.c
1632 * Caller: library/pkparse.c
1633 *
1634 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
1635 * Can use: MBEDTLS_ARC4_C
1636 *
1637 * This module enables PKCS#12 functions.
1638 */
1639#define MBEDTLS_PKCS12_C
1640
1641/**
1642 * \def MBEDTLS_PLATFORM_C
1643 *
1644 * Enable the platform abstraction layer that allows you to re-assign
1645 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
1646 *
1647 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
1648 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
1649 * above to be specified at runtime or compile time respectively.
1650 *
1651 * \note This abstraction layer must be enabled on Windows (including MSYS2)
1652 * as other module rely on it for a fixed snprintf implementation.
1653 *
1654 * Module: library/platform.c
1655 * Caller: Most other .c files
1656 *
1657 * This module enables abstraction of common (libc) functions.
1658 */
1659#define MBEDTLS_PLATFORM_C
1660
1661/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001662 * \def MBEDTLS_POLY1305_C
1663 *
1664 * Enable the Poly1305 MAC algorithm.
1665 *
1666 * Module: library/poly1305.c
1667 * Caller: library/chachapoly.c
1668 */
1669#define MBEDTLS_POLY1305_C
1670
1671/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001672 * \def MBEDTLS_PSA_CRYPTO_C
1673 *
1674 * Enable the Platform Security Architecture cryptography API.
1675 *
1676 * Module: library/psa_crypto.c
1677 *
1678 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
1679 *
1680 */
1681#define MBEDTLS_PSA_CRYPTO_C
1682
1683/**
Darryl Greendb2b8db2018-06-15 13:06:04 +01001684 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
1685 *
1686 * Enable the Platform Security Architecture persistent key storage.
1687 *
1688 * Module: library/psa_crypto_storage.c
1689 *
Gilles Peskine088b77f2019-02-24 17:00:27 +01001690 * Requires: MBEDTLS_PSA_CRYPTO_C,
1691 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
1692 * the PSA ITS interface
Darryl Greendb2b8db2018-06-15 13:06:04 +01001693 */
1694#define MBEDTLS_PSA_CRYPTO_STORAGE_C
1695
1696/**
Gilles Peskinee435f232019-02-24 14:03:29 +01001697 * \def MBEDTLS_PSA_ITS_FILE_C
1698 *
1699 * Enable the emulation of the Platform Security Architecture
1700 * Internal Trusted Storage (PSA ITS) over files.
1701 *
1702 * Module: library/psa_its_file.c
1703 *
1704 * Requires: MBEDTLS_FS_IO
1705 */
Gilles Peskinee3dbdd82019-02-25 11:04:06 +01001706#define MBEDTLS_PSA_ITS_FILE_C
Moran Peker46119562018-11-20 18:30:34 +02001707
1708/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001709 * \def MBEDTLS_RIPEMD160_C
1710 *
1711 * Enable the RIPEMD-160 hash algorithm.
1712 *
1713 * Module: library/ripemd160.c
1714 * Caller: library/md.c
1715 *
1716 */
1717#define MBEDTLS_RIPEMD160_C
1718
1719/**
1720 * \def MBEDTLS_RSA_C
1721 *
1722 * Enable the RSA public-key cryptosystem.
1723 *
1724 * Module: library/rsa.c
1725 * library/rsa_internal.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001726 *
1727 * This module is used by the following key exchanges:
1728 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
1729 *
1730 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
1731 */
1732#define MBEDTLS_RSA_C
1733
1734/**
1735 * \def MBEDTLS_SHA1_C
1736 *
1737 * Enable the SHA1 cryptographic hash algorithm.
1738 *
1739 * Module: library/sha1.c
1740 * Caller: library/md.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001741 *
1742 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
1743 * depending on the handshake parameters, and for SHA1-signed certificates.
1744 *
1745 * \warning SHA-1 is considered a weak message digest and its use constitutes
1746 * a security risk. If possible, we recommend avoiding dependencies
1747 * on it, and considering stronger message digests instead.
1748 *
1749 */
1750#define MBEDTLS_SHA1_C
1751
1752/**
1753 * \def MBEDTLS_SHA256_C
1754 *
1755 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
1756 *
1757 * Module: library/sha256.c
1758 * Caller: library/entropy.c
1759 * library/md.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001760 *
1761 * This module adds support for SHA-224 and SHA-256.
1762 * This module is required for the SSL/TLS 1.2 PRF function.
1763 */
1764#define MBEDTLS_SHA256_C
1765
1766/**
1767 * \def MBEDTLS_SHA512_C
1768 *
1769 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
1770 *
1771 * Module: library/sha512.c
1772 * Caller: library/entropy.c
1773 * library/md.c
Gilles Peskined8374ba2018-02-16 20:36:55 +01001774 *
1775 * This module adds support for SHA-384 and SHA-512.
1776 */
1777#define MBEDTLS_SHA512_C
1778
1779/**
1780 * \def MBEDTLS_THREADING_C
1781 *
1782 * Enable the threading abstraction layer.
1783 * By default mbed TLS assumes it is used in a non-threaded environment or that
1784 * contexts are not shared between threads. If you do intend to use contexts
1785 * between threads, you will need to enable this layer to prevent race
1786 * conditions. See also our Knowledge Base article about threading:
1787 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
1788 *
1789 * Module: library/threading.c
1790 *
1791 * This allows different threading implementations (self-implemented or
1792 * provided).
1793 *
1794 * You will have to enable either MBEDTLS_THREADING_ALT or
1795 * MBEDTLS_THREADING_PTHREAD.
1796 *
1797 * Enable this layer to allow use of mutexes within mbed TLS
1798 */
1799//#define MBEDTLS_THREADING_C
1800
1801/**
Jaeden Amero06b161a2019-02-08 16:07:52 +00001802 * \def MBEDTLS_TIMING_C
1803 *
1804 * Enable the semi-portable timing interface.
1805 *
1806 * \note The provided implementation only works on POSIX/Unix (including Linux,
1807 * BSD and OS X) and Windows. On other platforms, you can either disable that
Jaeden Amero1c66e482018-11-02 18:15:18 +00001808 * module and provide your own implementations of the callbacks needed by Mbed
1809 * TLS's \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and
1810 * provide your own implementation of the whole module by setting
Jaeden Amero06b161a2019-02-08 16:07:52 +00001811 * \c MBEDTLS_TIMING_ALT in the current file.
1812 *
1813 * \note See also our Knowledge Base article about porting to a new
1814 * environment:
1815 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
1816 *
1817 * Module: library/timing.c
1818 * Caller: library/havege.c
1819 *
1820 * This module is used by the HAVEGE random number generator.
1821 */
1822#define MBEDTLS_TIMING_C
1823
1824/**
Gilles Peskined8374ba2018-02-16 20:36:55 +01001825 * \def MBEDTLS_VERSION_C
1826 *
1827 * Enable run-time version information.
1828 *
1829 * Module: library/version.c
1830 *
1831 * This module provides run-time version information.
1832 */
1833#define MBEDTLS_VERSION_C
1834
1835/**
1836 * \def MBEDTLS_XTEA_C
1837 *
1838 * Enable the XTEA block cipher.
1839 *
1840 * Module: library/xtea.c
1841 * Caller:
1842 */
1843#define MBEDTLS_XTEA_C
1844
1845/* \} name SECTION: mbed TLS modules */
1846
1847/**
1848 * \name SECTION: Module configuration options
1849 *
1850 * This section allows for the setting of module specific sizes and
1851 * configuration options. The default values are already present in the
1852 * relevant header files and should suffice for the regular use cases.
1853 *
1854 * Our advice is to enable options and change their values here
1855 * only if you have a good reason and know the consequences.
1856 *
1857 * Please check the respective header file for documentation on these
1858 * parameters (to prevent duplicate documentation).
1859 * \{
1860 */
1861
1862/* MPI / BIGNUM options */
1863//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
1864//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
1865
1866/* CTR_DRBG options */
1867//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
1868//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1869//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1870//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1871//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001872//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY /**< Use 128-bit key for CTR_DRBG - may reduce security (see ctr_drbg.h) */
Gilles Peskined8374ba2018-02-16 20:36:55 +01001873
1874/* HMAC_DRBG options */
1875//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1876//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1877//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1878//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
1879
1880/* ECP options */
1881//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
1882//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
1883//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
1884
1885/* Entropy options */
1886//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
1887//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
1888//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32 /**< Default minimum number of bytes required for the hardware entropy source mbedtls_hardware_poll() before entropy is released */
1889
1890/* Memory buffer allocator options */
1891//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
1892
1893/* Platform options */
1894//#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. */
1895//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
1896//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
1897//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
1898//#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1899//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
1900//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001901/* Note: your snprintf must correctly zero-terminate the buffer! */
Gilles Peskined8374ba2018-02-16 20:36:55 +01001902//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
1903//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
1904//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
1905//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
1906//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
1907//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
1908
1909/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
1910/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
1911//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
1912//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
1913//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
1914//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1915//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1916//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
1917//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001918/* Note: your snprintf must correctly zero-terminate the buffer! */
Gilles Peskined8374ba2018-02-16 20:36:55 +01001919//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
Jaeden Amero06b161a2019-02-08 16:07:52 +00001920//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
Gilles Peskined8374ba2018-02-16 20:36:55 +01001921//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
1922//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
1923
Gilles Peskine13187932018-06-19 11:49:23 +02001924/**
1925 * Uncomment the macro to let mbed TLS use your alternate implementation of
1926 * mbedtls_platform_zeroize(). This replaces the default implementation in
1927 * platform_util.c.
1928 *
1929 * mbedtls_platform_zeroize() is a widely used function across the library to
1930 * zero a block of memory. The implementation is expected to be secure in the
1931 * sense that it has been written to prevent the compiler from removing calls
1932 * to mbedtls_platform_zeroize() as part of redundant code elimination
1933 * optimizations. However, it is difficult to guarantee that calls to
1934 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
1935 * versions of the C language standards do not provide a secure implementation
1936 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
1937 * configure their own implementation of mbedtls_platform_zeroize(), for
1938 * example by using directives specific to their compiler, features from newer
1939 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
1940 * their system (e.g explicit_bzero() in BSD).
1941 */
1942//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
1943
Jaeden Amero06b161a2019-02-08 16:07:52 +00001944/**
1945 * Uncomment the macro to let Mbed TLS use your alternate implementation of
1946 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
1947 * platform_util.c.
1948 *
1949 * gmtime() is not a thread-safe function as defined in the C standard. The
1950 * library will try to use safer implementations of this function, such as
1951 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
1952 * system, the implementation of mbedtls_platform_gmtime_r() will default to
1953 * using the standard gmtime(). In this case, calls from the library to
1954 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
1955 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
1956 * library are also guarded with this mutex to avoid race conditions. However,
1957 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
1958 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
1959 * supplied at compile time.
1960 */
1961//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
1962
Gilles Peskined8374ba2018-02-16 20:36:55 +01001963/* \} name SECTION: Customisation configuration options */
1964
Jaeden Amero06b161a2019-02-08 16:07:52 +00001965/* Target and application specific configurations
1966 *
1967 * Allow user to override any previous default.
1968 *
1969 */
1970#if defined(MBEDTLS_USER_CONFIG_FILE)
1971#include MBEDTLS_USER_CONFIG_FILE
1972#endif
1973
1974#include "check_config.h"
Gilles Peskined8374ba2018-02-16 20:36:55 +01001975
1976#endif /* MBEDTLS_CONFIG_H */