blob: a7e5ddfc5810721dc868248b0062229ecc519750 [file] [log] [blame]
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001/**
2 * \file config.h
3 *
4 * \brief Configuration options (set of defines)
5 *
6 * This set of compile-time options may be used to enable
7 * or disable features selectively, and reduce the global
8 * memory footprint.
9 */
10/*
Jamie Fox92371712020-01-17 15:12:13 +000011 * Copyright (C) 2006-2020, ARM Limited, All Rights Reserved
Jamie Fox0e54ebc2019-04-09 14:21:04 +010012 * 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:
51 * library/aria.c
52 * library/timing.c
53 * include/mbedtls/bn_mul.h
54 *
55 * Required by:
56 * MBEDTLS_AESNI_C
57 * MBEDTLS_PADLOCK_C
58 *
59 * 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/**
92 * \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/**
114 * \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/**
123 * \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/**
159 * \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 *
219 * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME
220 *
221 * Uncomment a macro to enable alternate implementation of specific base
222 * platform function
223 */
224//#define MBEDTLS_PLATFORM_EXIT_ALT
225//#define MBEDTLS_PLATFORM_TIME_ALT
226//#define MBEDTLS_PLATFORM_FPRINTF_ALT
227//#define MBEDTLS_PLATFORM_PRINTF_ALT
228//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
229//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
230//#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
260/**
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
302/* \} 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/**
313 * \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/**
326 * \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
352//#define MBEDTLS_ARIA_ALT
353//#define MBEDTLS_BLOWFISH_ALT
354//#define MBEDTLS_CAMELLIA_ALT
355//#define MBEDTLS_CCM_ALT
356//#define MBEDTLS_CHACHA20_ALT
357//#define MBEDTLS_CHACHAPOLY_ALT
358//#define MBEDTLS_CMAC_ALT
359//#define MBEDTLS_DES_ALT
360//#define MBEDTLS_DHM_ALT
361//#define MBEDTLS_ECJPAKE_ALT
362//#define MBEDTLS_GCM_ALT
363//#define MBEDTLS_NIST_KW_ALT
364//#define MBEDTLS_MD2_ALT
365//#define MBEDTLS_MD4_ALT
366//#define MBEDTLS_MD5_ALT
367//#define MBEDTLS_POLY1305_ALT
368//#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
374
375/*
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
405 * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt
406 * 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 )
460 * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp )
461 * 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.
464 * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are
465 * 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 *
527 * Use precomputed AES tables stored in ROM.
528 *
529 * 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 *
541 */
542//#define MBEDTLS_AES_ROM_TABLES
543
544/**
545 * \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/**
567 * \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/**
597 * \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 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +0100608//#define MBEDTLS_CIPHER_MODE_XTS
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100609
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 *
Jamie Fox92371712020-01-17 15:12:13 +0000617 * This module is required to support the TLS ciphersuites that use the NULL
618 * cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100619 *
Jamie Fox92371712020-01-17 15:12:13 +0000620 * Uncomment this macro to enable the NULL cipher
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100621 */
622//#define MBEDTLS_CIPHER_NULL_CIPHER
623
624/**
625 * \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/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100641 * \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
660#define MBEDTLS_ECP_DP_CURVE448_ENABLED
661
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/**
674 * \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
Jamie Fox92371712020-01-17 15:12:13 +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
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100684 * 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
Jamie Fox92371712020-01-17 15:12:13 +0000693 * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT
694 * and MBEDTLS_ECDH_LEGACY_CONTEXT.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100695 */
696//#define MBEDTLS_ECP_RESTARTABLE
697
698/**
Jamie Fox92371712020-01-17 15:12:13 +0000699 * \def MBEDTLS_ECDH_LEGACY_CONTEXT
700 *
701 * Use a backward compatible ECDH context.
702 *
703 * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context
704 * defined in `ecdh.h`). For most applications, the choice of format makes
705 * no difference, since all library functions can work with either format,
706 * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE.
707
708 * The new format used when this option is disabled is smaller
709 * (56 bytes on a 32-bit platform). In future versions of the library, it
710 * will support alternative implementations of ECDH operations.
711 * The new format is incompatible with applications that access
712 * context fields directly and with restartable ECP operations.
713 *
714 * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you
715 * want to access ECDH context fields directly. Otherwise you should
716 * comment out this macro definition.
717 *
718 * This option has no effect if #MBEDTLS_ECDH_C is not enabled.
719 *
720 * \note This configuration option is experimental. Future versions of the
721 * library may modify the way the ECDH context layout is configured
722 * and may modify the layout of the new context type.
723 */
724//#define MBEDTLS_ECDH_LEGACY_CONTEXT
725
726/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100727 * \def MBEDTLS_ECDSA_DETERMINISTIC
728 *
729 * Enable deterministic ECDSA (RFC 6979).
730 * Standard ECDSA is "fragile" in the sense that lack of entropy when signing
731 * may result in a compromise of the long-term signing key. This is avoided by
732 * the deterministic variant.
733 *
734 * Requires: MBEDTLS_HMAC_DRBG_C
735 *
736 * Comment this macro to disable deterministic ECDSA.
737 */
738#define MBEDTLS_ECDSA_DETERMINISTIC
739
740/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100741 * \def MBEDTLS_PK_PARSE_EC_EXTENDED
742 *
743 * Enhance support for reading EC keys using variants of SEC1 not allowed by
744 * RFC 5915 and RFC 5480.
745 *
746 * Currently this means parsing the SpecifiedECDomain choice of EC
747 * parameters (only known groups are supported, not arbitrary domains, to
748 * avoid validation issues).
749 *
750 * Disable if you only need to support RFC 5915 + 5480 key formats.
751 */
752#define MBEDTLS_PK_PARSE_EC_EXTENDED
753
754/**
755 * \def MBEDTLS_ERROR_STRERROR_DUMMY
756 *
757 * Enable a dummy error function to make use of mbedtls_strerror() in
758 * third party libraries easier when MBEDTLS_ERROR_C is disabled
759 * (no effect when MBEDTLS_ERROR_C is enabled).
760 *
761 * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're
762 * not using mbedtls_strerror() or error_strerror() in your application.
763 *
764 * Disable if you run into name conflicts and want to really remove the
765 * mbedtls_strerror()
766 */
767#define MBEDTLS_ERROR_STRERROR_DUMMY
768
769/**
770 * \def MBEDTLS_GENPRIME
771 *
772 * Enable the prime-number generation code.
773 *
774 * Requires: MBEDTLS_BIGNUM_C
775 */
776#define MBEDTLS_GENPRIME
777
778/**
779 * \def MBEDTLS_FS_IO
780 *
781 * Enable functions that use the filesystem.
782 */
783//#define MBEDTLS_FS_IO
784
785/**
786 * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
787 *
788 * Do not add default entropy sources. These are the platform specific,
789 * mbedtls_timing_hardclock and HAVEGE based poll functions.
790 *
791 * This is useful to have more control over the added entropy sources in an
792 * application.
793 *
794 * Uncomment this macro to prevent loading of default entropy functions.
795 */
796#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
797
798/**
799 * \def MBEDTLS_NO_PLATFORM_ENTROPY
800 *
801 * Do not use built-in platform entropy functions.
802 * This is useful if your platform does not support
803 * standards like the /dev/urandom or Windows CryptoAPI.
804 *
805 * Uncomment this macro to disable the built-in platform entropy functions.
806 */
807#define MBEDTLS_NO_PLATFORM_ENTROPY
808
809/**
810 * \def MBEDTLS_ENTROPY_FORCE_SHA256
811 *
812 * Force the entropy accumulator to use a SHA-256 accumulator instead of the
813 * default SHA-512 based one (if both are available).
814 *
815 * Requires: MBEDTLS_SHA256_C
816 *
817 * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option
818 * if you have performance concerns.
819 *
820 * This option is only useful if both MBEDTLS_SHA256_C and
821 * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used.
822 */
823//#define MBEDTLS_ENTROPY_FORCE_SHA256
824
825/**
826 * \def MBEDTLS_ENTROPY_NV_SEED
827 *
828 * Enable the non-volatile (NV) seed file-based entropy source.
829 * (Also enables the NV seed read/write functions in the platform layer)
830 *
831 * This is crucial (if not required) on systems that do not have a
832 * cryptographic entropy source (in hardware or kernel) available.
833 *
834 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C
835 *
836 * \note The read/write functions that are used by the entropy source are
837 * determined in the platform layer, and can be modified at runtime and/or
838 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used.
839 *
840 * \note If you use the default implementation functions that read a seedfile
841 * with regular fopen(), please make sure you make a seedfile with the
842 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at
843 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from
844 * and written to or you will get an entropy source error! The default
845 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE
846 * bytes from the file.
847 *
848 * \note The entropy collector will write to the seed file before entropy is
849 * given to an external source, to update it.
850 */
851//#define MBEDTLS_ENTROPY_NV_SEED
852
Jamie Fox92371712020-01-17 15:12:13 +0000853/* MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100854 *
Jamie Fox92371712020-01-17 15:12:13 +0000855 * In PSA key storage, encode the owner of the key.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100856 *
Jamie Fox92371712020-01-17 15:12:13 +0000857 * This is only meaningful when building the library as part of a
858 * multi-client service. When you activate this option, you must provide
859 * an implementation of the type psa_key_owner_id_t and a translation
860 * from psa_key_file_id_t to file name in all the storage backends that
861 * you wish to support.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100862 *
Jamie Fox92371712020-01-17 15:12:13 +0000863 * Note that this option is meant for internal use only and may be removed
864 * without notice.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100865 */
Jamie Fox92371712020-01-17 15:12:13 +0000866//#define MBEDTLS_PSA_CRYPTO_KEY_FILE_ID_ENCODES_OWNER
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100867
868/**
869 * \def MBEDTLS_MEMORY_DEBUG
870 *
871 * Enable debugging of buffer allocator memory issues. Automatically prints
872 * (to stderr) all (fatal) messages on memory allocation issues. Enables
873 * function for 'debug output' of allocated memory.
874 *
875 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
876 *
877 * Uncomment this macro to let the buffer allocator print out error messages.
878 */
879//#define MBEDTLS_MEMORY_DEBUG
880
881/**
882 * \def MBEDTLS_MEMORY_BACKTRACE
883 *
884 * Include backtrace information with each allocated block.
885 *
886 * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C
887 * GLIBC-compatible backtrace() an backtrace_symbols() support
888 *
889 * Uncomment this macro to include backtrace information
890 */
891//#define MBEDTLS_MEMORY_BACKTRACE
892
893/**
894 * \def MBEDTLS_PK_RSA_ALT_SUPPORT
895 *
896 * Support external private RSA keys (eg from a HSM) in the PK layer.
897 *
898 * Comment this macro to disable support for external private RSA keys.
899 */
900#define MBEDTLS_PK_RSA_ALT_SUPPORT
901
902/**
903 * \def MBEDTLS_PKCS1_V15
904 *
905 * Enable support for PKCS#1 v1.5 encoding.
906 *
907 * Requires: MBEDTLS_RSA_C
908 *
909 * This enables support for PKCS#1 v1.5 operations.
910 */
911#define MBEDTLS_PKCS1_V15
912
913/**
914 * \def MBEDTLS_PKCS1_V21
915 *
916 * Enable support for PKCS#1 v2.1 encoding.
917 *
918 * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C
919 *
920 * This enables support for RSAES-OAEP and RSASSA-PSS operations.
921 */
922#define MBEDTLS_PKCS1_V21
923
924/**
925 * \def MBEDTLS_PSA_CRYPTO_SPM
926 *
927 * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure
928 * Partition Manager) integration which separates the code into two parts: a
929 * NSPE (Non-Secure Process Environment) and an SPE (Secure Process
930 * Environment).
931 *
932 * Module: library/psa_crypto.c
933 * Requires: MBEDTLS_PSA_CRYPTO_C
934 *
935 */
936#define MBEDTLS_PSA_CRYPTO_SPM
937
938/**
Jamie Fox92371712020-01-17 15:12:13 +0000939 * \def MBEDTLS_PSA_INJECT_ENTROPY
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100940 *
Jamie Fox92371712020-01-17 15:12:13 +0000941 * Enable support for entropy injection at first boot. This feature is
942 * required on systems that do not have a built-in entropy source (TRNG).
943 * This feature is currently not supported on systems that have a built-in
944 * entropy source.
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100945 *
Jamie Fox92371712020-01-17 15:12:13 +0000946 * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100947 *
948 */
Jamie Fox92371712020-01-17 15:12:13 +0000949//#define MBEDTLS_PSA_INJECT_ENTROPY
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100950
951/**
952 * \def MBEDTLS_RSA_NO_CRT
953 *
954 * Do not use the Chinese Remainder Theorem
955 * for the RSA private operation.
956 *
957 * Uncomment this macro to disable the use of CRT in RSA.
958 *
959 */
960//#define MBEDTLS_RSA_NO_CRT
961
962/**
963 * \def MBEDTLS_SELF_TEST
964 *
965 * Enable the checkup functions (*_self_test).
966 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +0100967//#define MBEDTLS_SELF_TEST
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100968
969/**
970 * \def MBEDTLS_SHA256_SMALLER
971 *
972 * Enable an implementation of SHA-256 that has lower ROM footprint but also
973 * lower performance.
974 *
975 * The default implementation is meant to be a reasonnable compromise between
976 * performance and size. This version optimizes more aggressively for size at
977 * the expense of performance. Eg on Cortex-M4 it reduces the size of
978 * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about
979 * 30%.
980 *
981 * Uncomment to enable the smaller implementation of SHA256.
982 */
983//#define MBEDTLS_SHA256_SMALLER
984
985/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +0100986 * \def MBEDTLS_THREADING_ALT
987 *
988 * Provide your own alternate threading implementation.
989 *
990 * Requires: MBEDTLS_THREADING_C
991 *
992 * Uncomment this to allow your own alternate threading implementation.
993 */
994//#define MBEDTLS_THREADING_ALT
995
996/**
997 * \def MBEDTLS_THREADING_PTHREAD
998 *
999 * Enable the pthread wrapper layer for the threading layer.
1000 *
1001 * Requires: MBEDTLS_THREADING_C
1002 *
1003 * Uncomment this to enable pthread mutexes.
1004 */
1005//#define MBEDTLS_THREADING_PTHREAD
1006
1007/**
1008 * \def MBEDTLS_USE_PSA_CRYPTO
1009 *
1010 * Make the X.509 and TLS library use PSA for cryptographic operations, see
1011 * #MBEDTLS_PSA_CRYPTO_C.
1012 *
1013 * Note: this option is still in progress, the full X.509 and TLS modules are
1014 * not covered yet, but parts that are not ported to PSA yet will still work
1015 * as usual, so enabling this option should not break backwards compatibility.
1016 *
1017 * \warning Support for PSA is still an experimental feature.
1018 * Any public API that depends on this option may change
1019 * at any time until this warning is removed.
1020 *
1021 * Requires: MBEDTLS_PSA_CRYPTO_C.
1022 */
1023//#define MBEDTLS_USE_PSA_CRYPTO
1024
1025/**
1026 * \def MBEDTLS_VERSION_FEATURES
1027 *
1028 * Allow run-time checking of compile-time enabled features. Thus allowing users
1029 * to check at run-time if the library is for instance compiled with threading
1030 * support via mbedtls_version_check_feature().
1031 *
1032 * Requires: MBEDTLS_VERSION_C
1033 *
1034 * Comment this to disable run-time checking and save ROM space
1035 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001036//#define MBEDTLS_VERSION_FEATURES
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001037
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001038/* \} name SECTION: mbed TLS feature support */
1039
1040/**
1041 * \name SECTION: mbed TLS modules
1042 *
1043 * This section enables or disables entire modules in mbed TLS
1044 * \{
1045 */
1046
1047/**
1048 * \def MBEDTLS_AESNI_C
1049 *
1050 * Enable AES-NI support on x86-64.
1051 *
1052 * Module: library/aesni.c
1053 * Caller: library/aes.c
1054 *
1055 * Requires: MBEDTLS_HAVE_ASM
1056 *
1057 * This modules adds support for the AES-NI instructions on x86-64
1058 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001059//#define MBEDTLS_AESNI_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001060
1061/**
1062 * \def MBEDTLS_AES_C
1063 *
1064 * Enable the AES block cipher.
1065 *
1066 * Module: library/aes.c
1067 * Caller: library/cipher.c
1068 * library/pem.c
1069 * library/ctr_drbg.c
1070 *
Jamie Fox92371712020-01-17 15:12:13 +00001071 * This module is required to support the TLS ciphersuites that use the AES
1072 * cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001073 *
1074 * PEM_PARSE uses AES for decrypting encrypted keys.
1075 */
1076#define MBEDTLS_AES_C
1077
1078/**
1079 * \def MBEDTLS_ARC4_C
1080 *
1081 * Enable the ARCFOUR stream cipher.
1082 *
1083 * Module: library/arc4.c
1084 * Caller: library/cipher.c
1085 *
Jamie Fox92371712020-01-17 15:12:13 +00001086 * This module is required to support the TLS ciphersuites that use the ARC4
1087 * cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001088 *
1089 * \warning ARC4 is considered a weak cipher and its use constitutes a
1090 * security risk. If possible, we recommend avoidng dependencies on
1091 * it, and considering stronger ciphers instead.
1092 *
1093 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001094//#define MBEDTLS_ARC4_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001095
1096/**
1097 * \def MBEDTLS_ASN1_PARSE_C
1098 *
1099 * Enable the generic ASN1 parser.
1100 *
1101 * Module: library/asn1.c
Jamie Fox92371712020-01-17 15:12:13 +00001102 * Caller: library/dhm.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001103 * library/pkcs12.c
1104 * library/pkcs5.c
1105 * library/pkparse.c
1106 */
1107#define MBEDTLS_ASN1_PARSE_C
1108
1109/**
1110 * \def MBEDTLS_ASN1_WRITE_C
1111 *
1112 * Enable the generic ASN1 writer.
1113 *
1114 * Module: library/asn1write.c
1115 * Caller: library/ecdsa.c
1116 * library/pkwrite.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001117 */
1118#define MBEDTLS_ASN1_WRITE_C
1119
1120/**
1121 * \def MBEDTLS_BASE64_C
1122 *
1123 * Enable the Base64 module.
1124 *
1125 * Module: library/base64.c
1126 * Caller: library/pem.c
1127 *
1128 * This module is required for PEM support (required by X.509).
1129 */
1130#define MBEDTLS_BASE64_C
1131
1132/**
1133 * \def MBEDTLS_BIGNUM_C
1134 *
1135 * Enable the multi-precision integer library.
1136 *
1137 * Module: library/bignum.c
1138 * Caller: library/dhm.c
1139 * library/ecp.c
1140 * library/ecdsa.c
1141 * library/rsa.c
1142 * library/rsa_internal.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001143 *
1144 * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support.
1145 */
1146#define MBEDTLS_BIGNUM_C
1147
1148/**
1149 * \def MBEDTLS_BLOWFISH_C
1150 *
1151 * Enable the Blowfish block cipher.
1152 *
1153 * Module: library/blowfish.c
1154 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001155//#define MBEDTLS_BLOWFISH_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001156
1157/**
1158 * \def MBEDTLS_CAMELLIA_C
1159 *
1160 * Enable the Camellia block cipher.
1161 *
1162 * Module: library/camellia.c
1163 * Caller: library/cipher.c
1164 *
Jamie Fox92371712020-01-17 15:12:13 +00001165 * This module is required to support the TLS ciphersuites that use the
1166 * Camellia cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001167 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001168//#define MBEDTLS_CAMELLIA_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001169
1170/**
1171 * \def MBEDTLS_ARIA_C
1172 *
1173 * Enable the ARIA block cipher.
1174 *
1175 * Module: library/aria.c
1176 * Caller: library/cipher.c
1177 *
Jamie Fox92371712020-01-17 15:12:13 +00001178 * This module is required to support the TLS ciphersuites that use the
1179 * ARIA cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001180 */
1181//#define MBEDTLS_ARIA_C
1182
1183/**
1184 * \def MBEDTLS_CCM_C
1185 *
1186 * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher.
1187 *
1188 * Module: library/ccm.c
1189 *
1190 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C
1191 *
Jamie Fox92371712020-01-17 15:12:13 +00001192 * This module is required to support AES-CCM ciphersuites in TLS.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001193 */
1194#define MBEDTLS_CCM_C
1195
1196/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001197 * \def MBEDTLS_CHACHA20_C
1198 *
1199 * Enable the ChaCha20 stream cipher.
1200 *
1201 * Module: library/chacha20.c
1202 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001203//#define MBEDTLS_CHACHA20_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001204
1205/**
1206 * \def MBEDTLS_CHACHAPOLY_C
1207 *
1208 * Enable the ChaCha20-Poly1305 AEAD algorithm.
1209 *
1210 * Module: library/chachapoly.c
1211 *
1212 * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C
1213 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001214//#define MBEDTLS_CHACHAPOLY_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001215
1216/**
1217 * \def MBEDTLS_CIPHER_C
1218 *
1219 * Enable the generic cipher layer.
1220 *
1221 * Module: library/cipher.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001222 *
1223 * Uncomment to enable generic cipher wrappers.
1224 */
1225#define MBEDTLS_CIPHER_C
1226
1227/**
1228 * \def MBEDTLS_CMAC_C
1229 *
1230 * Enable the CMAC (Cipher-based Message Authentication Code) mode for block
1231 * ciphers.
1232 *
1233 * Module: library/cmac.c
1234 *
1235 * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C
1236 *
1237 */
1238#define MBEDTLS_CMAC_C
1239
1240/**
1241 * \def MBEDTLS_CTR_DRBG_C
1242 *
1243 * Enable the CTR_DRBG AES-based random generator.
1244 * The CTR_DRBG generator uses AES-256 by default.
1245 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below.
1246 *
1247 * Module: library/ctr_drbg.c
1248 * Caller:
1249 *
1250 * Requires: MBEDTLS_AES_C
1251 *
1252 * This module provides the CTR_DRBG AES random number generator.
1253 */
1254#define MBEDTLS_CTR_DRBG_C
1255
1256/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001257 * \def MBEDTLS_DES_C
1258 *
1259 * Enable the DES block cipher.
1260 *
1261 * Module: library/des.c
1262 * Caller: library/pem.c
1263 * library/cipher.c
1264 *
Jamie Fox92371712020-01-17 15:12:13 +00001265 * This module is required to support the TLS ciphersuites that use the DES
1266 * cipher.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001267 *
1268 * PEM_PARSE uses DES/3DES for decrypting encrypted keys.
1269 *
1270 * \warning DES is considered a weak cipher and its use constitutes a
1271 * security risk. We recommend considering stronger ciphers instead.
1272 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001273//#define MBEDTLS_DES_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001274
1275/**
1276 * \def MBEDTLS_DHM_C
1277 *
1278 * Enable the Diffie-Hellman-Merkle module.
1279 *
1280 * Module: library/dhm.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001281 *
1282 * This module is used by the following key exchanges:
1283 * DHE-RSA, DHE-PSK
1284 *
1285 * \warning Using DHE constitutes a security risk as it
1286 * is not possible to validate custom DH parameters.
1287 * If possible, it is recommended users should consider
1288 * preferring other methods of key exchange.
1289 * See dhm.h for more details.
1290 *
1291 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001292//#define MBEDTLS_DHM_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001293
1294/**
1295 * \def MBEDTLS_ECDH_C
1296 *
1297 * Enable the elliptic curve Diffie-Hellman library.
1298 *
1299 * Module: library/ecdh.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001300 *
1301 * This module is used by the following key exchanges:
1302 * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK
1303 *
1304 * Requires: MBEDTLS_ECP_C
1305 */
1306#define MBEDTLS_ECDH_C
1307
1308/**
1309 * \def MBEDTLS_ECDSA_C
1310 *
1311 * Enable the elliptic curve DSA library.
1312 *
1313 * Module: library/ecdsa.c
1314 * Caller:
1315 *
1316 * This module is used by the following key exchanges:
1317 * ECDHE-ECDSA
1318 *
1319 * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C
1320 */
1321#define MBEDTLS_ECDSA_C
1322
1323/**
1324 * \def MBEDTLS_ECJPAKE_C
1325 *
1326 * Enable the elliptic curve J-PAKE library.
1327 *
1328 * \warning This is currently experimental. EC J-PAKE support is based on the
1329 * Thread v1.0.0 specification; incompatible changes to the specification
1330 * might still happen. For this reason, this is disabled by default.
1331 *
1332 * Module: library/ecjpake.c
1333 * Caller:
1334 *
1335 * This module is used by the following key exchanges:
1336 * ECJPAKE
1337 *
1338 * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C
1339 */
1340//#define MBEDTLS_ECJPAKE_C
1341
1342/**
1343 * \def MBEDTLS_ECP_C
1344 *
1345 * Enable the elliptic curve over GF(p) library.
1346 *
1347 * Module: library/ecp.c
1348 * Caller: library/ecdh.c
1349 * library/ecdsa.c
1350 * library/ecjpake.c
1351 *
1352 * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED
1353 */
1354#define MBEDTLS_ECP_C
1355
1356/**
1357 * \def MBEDTLS_ENTROPY_C
1358 *
1359 * Enable the platform-specific entropy code.
1360 *
1361 * Module: library/entropy.c
1362 * Caller:
1363 *
1364 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C
1365 *
1366 * This module provides a generic entropy pool
1367 */
1368#define MBEDTLS_ENTROPY_C
1369
1370/**
1371 * \def MBEDTLS_ERROR_C
1372 *
1373 * Enable error code to error string conversion.
1374 *
1375 * Module: library/error.c
1376 * Caller:
1377 *
1378 * This module enables mbedtls_strerror().
1379 */
1380#define MBEDTLS_ERROR_C
1381
1382/**
1383 * \def MBEDTLS_GCM_C
1384 *
Jamie Fox92371712020-01-17 15:12:13 +00001385 * Enable the Galois/Counter Mode (GCM).
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001386 *
1387 * Module: library/gcm.c
1388 *
Jamie Fox92371712020-01-17 15:12:13 +00001389 * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001390 *
Jamie Fox92371712020-01-17 15:12:13 +00001391 * This module is required to support the TLS ciphersuites that use GCM.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001392 */
1393#define MBEDTLS_GCM_C
1394
1395/**
1396 * \def MBEDTLS_HAVEGE_C
1397 *
1398 * Enable the HAVEGE random generator.
1399 *
1400 * Warning: the HAVEGE random generator is not suitable for virtualized
1401 * environments
1402 *
1403 * Warning: the HAVEGE random generator is dependent on timing and specific
1404 * processor traits. It is therefore not advised to use HAVEGE as
1405 * your applications primary random generator or primary entropy pool
1406 * input. As a secondary input to your entropy pool, it IS able add
1407 * the (limited) extra entropy it provides.
1408 *
1409 * Module: library/havege.c
1410 * Caller:
1411 *
1412 * Requires: MBEDTLS_TIMING_C
1413 *
1414 * Uncomment to enable the HAVEGE random generator.
1415 */
1416//#define MBEDTLS_HAVEGE_C
1417
1418/**
1419 * \def MBEDTLS_HKDF_C
1420 *
1421 * Enable the HKDF algorithm (RFC 5869).
1422 *
1423 * Module: library/hkdf.c
1424 * Caller:
1425 *
1426 * Requires: MBEDTLS_MD_C
1427 *
1428 * This module adds support for the Hashed Message Authentication Code
1429 * (HMAC)-based key derivation function (HKDF).
1430 */
1431#define MBEDTLS_HKDF_C
1432
1433/**
1434 * \def MBEDTLS_HMAC_DRBG_C
1435 *
1436 * Enable the HMAC_DRBG random generator.
1437 *
1438 * Module: library/hmac_drbg.c
1439 * Caller:
1440 *
1441 * Requires: MBEDTLS_MD_C
1442 *
1443 * Uncomment to enable the HMAC_DRBG random number geerator.
1444 */
1445#define MBEDTLS_HMAC_DRBG_C
1446
1447/**
1448 * \def MBEDTLS_NIST_KW_C
1449 *
1450 * Enable the Key Wrapping mode for 128-bit block ciphers,
1451 * as defined in NIST SP 800-38F. Only KW and KWP modes
1452 * are supported. At the moment, only AES is approved by NIST.
1453 *
1454 * Module: library/nist_kw.c
1455 *
1456 * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C
1457 */
1458//#define MBEDTLS_NIST_KW_C
1459
1460/**
1461 * \def MBEDTLS_MD_C
1462 *
1463 * Enable the generic message digest layer.
1464 *
1465 * Module: library/md.c
1466 * Caller:
1467 *
1468 * Uncomment to enable generic message digest wrappers.
1469 */
1470#define MBEDTLS_MD_C
1471
1472/**
1473 * \def MBEDTLS_MD2_C
1474 *
1475 * Enable the MD2 hash algorithm.
1476 *
1477 * Module: library/md2.c
1478 * Caller:
1479 *
1480 * Uncomment to enable support for (rare) MD2-signed X.509 certs.
1481 *
1482 * \warning MD2 is considered a weak message digest and its use constitutes a
1483 * security risk. If possible, we recommend avoiding dependencies on
1484 * it, and considering stronger message digests instead.
1485 *
1486 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001487//#define MBEDTLS_MD2_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001488
1489/**
1490 * \def MBEDTLS_MD4_C
1491 *
1492 * Enable the MD4 hash algorithm.
1493 *
1494 * Module: library/md4.c
1495 * Caller:
1496 *
1497 * Uncomment to enable support for (rare) MD4-signed X.509 certs.
1498 *
1499 * \warning MD4 is considered a weak message digest and its use constitutes a
1500 * security risk. If possible, we recommend avoiding dependencies on
1501 * it, and considering stronger message digests instead.
1502 *
1503 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001504//#define MBEDTLS_MD4_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001505
1506/**
1507 * \def MBEDTLS_MD5_C
1508 *
1509 * Enable the MD5 hash algorithm.
1510 *
1511 * Module: library/md5.c
1512 * Caller: library/md.c
1513 * library/pem.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001514 *
1515 * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2
1516 * depending on the handshake parameters. Further, it is used for checking
1517 * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded
1518 * encrypted keys.
1519 *
1520 * \warning MD5 is considered a weak message digest and its use constitutes a
1521 * security risk. If possible, we recommend avoiding dependencies on
1522 * it, and considering stronger message digests instead.
1523 *
1524 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001525//#define MBEDTLS_MD5_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001526
1527/**
1528 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C
1529 *
1530 * Enable the buffer allocator implementation that makes use of a (stack)
1531 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free()
1532 * calls)
1533 *
1534 * Module: library/memory_buffer_alloc.c
1535 *
1536 * Requires: MBEDTLS_PLATFORM_C
1537 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS)
1538 *
1539 * Enable this module to enable the buffer memory allocator.
1540 */
1541#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
1542
1543/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001544 * \def MBEDTLS_OID_C
1545 *
1546 * Enable the OID database.
1547 *
1548 * Module: library/oid.c
1549 * Caller: library/asn1write.c
1550 * library/pkcs5.c
1551 * library/pkparse.c
1552 * library/pkwrite.c
1553 * library/rsa.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001554 *
1555 * This modules translates between OIDs and internal values.
1556 */
1557#define MBEDTLS_OID_C
1558
1559/**
1560 * \def MBEDTLS_PADLOCK_C
1561 *
1562 * Enable VIA Padlock support on x86.
1563 *
1564 * Module: library/padlock.c
1565 * Caller: library/aes.c
1566 *
1567 * Requires: MBEDTLS_HAVE_ASM
1568 *
1569 * This modules adds support for the VIA PadLock on x86.
1570 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001571//#define MBEDTLS_PADLOCK_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001572
1573/**
1574 * \def MBEDTLS_PEM_PARSE_C
1575 *
1576 * Enable PEM decoding / parsing.
1577 *
1578 * Module: library/pem.c
1579 * Caller: library/dhm.c
1580 * library/pkparse.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001581 *
1582 * Requires: MBEDTLS_BASE64_C
1583 *
1584 * This modules adds support for decoding / parsing PEM files.
1585 */
1586#define MBEDTLS_PEM_PARSE_C
1587
1588/**
1589 * \def MBEDTLS_PEM_WRITE_C
1590 *
1591 * Enable PEM encoding / writing.
1592 *
1593 * Module: library/pem.c
1594 * Caller: library/pkwrite.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001595 *
1596 * Requires: MBEDTLS_BASE64_C
1597 *
1598 * This modules adds support for encoding / writing PEM files.
1599 */
1600#define MBEDTLS_PEM_WRITE_C
1601
1602/**
1603 * \def MBEDTLS_PK_C
1604 *
1605 * Enable the generic public (asymetric) key layer.
1606 *
1607 * Module: library/pk.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001608 *
1609 * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C
1610 *
1611 * Uncomment to enable generic public key wrappers.
1612 */
1613#define MBEDTLS_PK_C
1614
1615/**
1616 * \def MBEDTLS_PK_PARSE_C
1617 *
1618 * Enable the generic public (asymetric) key parser.
1619 *
1620 * Module: library/pkparse.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001621 *
1622 * Requires: MBEDTLS_PK_C
1623 *
1624 * Uncomment to enable generic public key parse functions.
1625 */
1626#define MBEDTLS_PK_PARSE_C
1627
1628/**
1629 * \def MBEDTLS_PK_WRITE_C
1630 *
1631 * Enable the generic public (asymetric) key writer.
1632 *
1633 * Module: library/pkwrite.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001634 *
1635 * Requires: MBEDTLS_PK_C
1636 *
1637 * Uncomment to enable generic public key write functions.
1638 */
1639#define MBEDTLS_PK_WRITE_C
1640
1641/**
1642 * \def MBEDTLS_PKCS5_C
1643 *
1644 * Enable PKCS#5 functions.
1645 *
1646 * Module: library/pkcs5.c
1647 *
1648 * Requires: MBEDTLS_MD_C
1649 *
1650 * This module adds support for the PKCS#5 functions.
1651 */
1652#define MBEDTLS_PKCS5_C
1653
1654/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001655 * \def MBEDTLS_PKCS12_C
1656 *
1657 * Enable PKCS#12 PBE functions.
1658 * Adds algorithms for parsing PKCS#8 encrypted private keys
1659 *
1660 * Module: library/pkcs12.c
1661 * Caller: library/pkparse.c
1662 *
1663 * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C
1664 * Can use: MBEDTLS_ARC4_C
1665 *
1666 * This module enables PKCS#12 functions.
1667 */
1668#define MBEDTLS_PKCS12_C
1669
1670/**
1671 * \def MBEDTLS_PLATFORM_C
1672 *
1673 * Enable the platform abstraction layer that allows you to re-assign
1674 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit().
1675 *
1676 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT
1677 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned
1678 * above to be specified at runtime or compile time respectively.
1679 *
1680 * \note This abstraction layer must be enabled on Windows (including MSYS2)
1681 * as other module rely on it for a fixed snprintf implementation.
1682 *
1683 * Module: library/platform.c
1684 * Caller: Most other .c files
1685 *
1686 * This module enables abstraction of common (libc) functions.
1687 */
1688#define MBEDTLS_PLATFORM_C
1689
1690/**
1691 * \def MBEDTLS_POLY1305_C
1692 *
1693 * Enable the Poly1305 MAC algorithm.
1694 *
1695 * Module: library/poly1305.c
1696 * Caller: library/chachapoly.c
1697 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001698//#define MBEDTLS_POLY1305_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001699
1700/**
1701 * \def MBEDTLS_PSA_CRYPTO_C
1702 *
1703 * Enable the Platform Security Architecture cryptography API.
1704 *
1705 * Module: library/psa_crypto.c
1706 *
1707 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C
1708 *
1709 */
1710#define MBEDTLS_PSA_CRYPTO_C
1711
1712/**
1713 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C
1714 *
1715 * Enable the Platform Security Architecture persistent key storage.
1716 *
1717 * Module: library/psa_crypto_storage.c
1718 *
Jamie Fox92371712020-01-17 15:12:13 +00001719 * Requires: MBEDTLS_PSA_CRYPTO_C,
1720 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of
1721 * the PSA ITS interface
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001722 */
1723//#define MBEDTLS_PSA_CRYPTO_STORAGE_C
1724
1725/**
Jamie Fox92371712020-01-17 15:12:13 +00001726 * \def MBEDTLS_PSA_ITS_FILE_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001727 *
Jamie Fox92371712020-01-17 15:12:13 +00001728 * Enable the emulation of the Platform Security Architecture
1729 * Internal Trusted Storage (PSA ITS) over files.
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001730 *
Jamie Fox92371712020-01-17 15:12:13 +00001731 * Module: library/psa_its_file.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001732 *
Jamie Fox92371712020-01-17 15:12:13 +00001733 * Requires: MBEDTLS_FS_IO
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001734 */
Jamie Fox92371712020-01-17 15:12:13 +00001735//#define MBEDTLS_PSA_ITS_FILE_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001736
1737/**
1738 * \def MBEDTLS_RIPEMD160_C
1739 *
1740 * Enable the RIPEMD-160 hash algorithm.
1741 *
1742 * Module: library/ripemd160.c
1743 * Caller: library/md.c
1744 *
1745 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001746//#define MBEDTLS_RIPEMD160_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001747
1748/**
1749 * \def MBEDTLS_RSA_C
1750 *
1751 * Enable the RSA public-key cryptosystem.
1752 *
1753 * Module: library/rsa.c
1754 * library/rsa_internal.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001755 *
1756 * This module is used by the following key exchanges:
1757 * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK
1758 *
1759 * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C
1760 */
1761#define MBEDTLS_RSA_C
1762
1763/**
1764 * \def MBEDTLS_SHA1_C
1765 *
1766 * Enable the SHA1 cryptographic hash algorithm.
1767 *
1768 * Module: library/sha1.c
1769 * Caller: library/md.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001770 *
1771 * This module is required for SSL/TLS up to version 1.1, for TLS 1.2
1772 * depending on the handshake parameters, and for SHA1-signed certificates.
1773 *
1774 * \warning SHA-1 is considered a weak message digest and its use constitutes
1775 * a security risk. If possible, we recommend avoiding dependencies
1776 * on it, and considering stronger message digests instead.
1777 *
1778 */
1779#define MBEDTLS_SHA1_C
1780
1781/**
1782 * \def MBEDTLS_SHA256_C
1783 *
1784 * Enable the SHA-224 and SHA-256 cryptographic hash algorithms.
1785 *
1786 * Module: library/sha256.c
1787 * Caller: library/entropy.c
1788 * library/md.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001789 *
1790 * This module adds support for SHA-224 and SHA-256.
1791 * This module is required for the SSL/TLS 1.2 PRF function.
1792 */
1793#define MBEDTLS_SHA256_C
1794
1795/**
1796 * \def MBEDTLS_SHA512_C
1797 *
1798 * Enable the SHA-384 and SHA-512 cryptographic hash algorithms.
1799 *
1800 * Module: library/sha512.c
1801 * Caller: library/entropy.c
1802 * library/md.c
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001803 *
1804 * This module adds support for SHA-384 and SHA-512.
1805 */
1806#define MBEDTLS_SHA512_C
1807
1808/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001809 * \def MBEDTLS_THREADING_C
1810 *
1811 * Enable the threading abstraction layer.
1812 * By default mbed TLS assumes it is used in a non-threaded environment or that
1813 * contexts are not shared between threads. If you do intend to use contexts
1814 * between threads, you will need to enable this layer to prevent race
1815 * conditions. See also our Knowledge Base article about threading:
1816 * https://tls.mbed.org/kb/development/thread-safety-and-multi-threading
1817 *
1818 * Module: library/threading.c
1819 *
1820 * This allows different threading implementations (self-implemented or
1821 * provided).
1822 *
1823 * You will have to enable either MBEDTLS_THREADING_ALT or
1824 * MBEDTLS_THREADING_PTHREAD.
1825 *
1826 * Enable this layer to allow use of mutexes within mbed TLS
1827 */
1828//#define MBEDTLS_THREADING_C
1829
1830/**
1831 * \def MBEDTLS_TIMING_C
1832 *
1833 * Enable the semi-portable timing interface.
1834 *
1835 * \note The provided implementation only works on POSIX/Unix (including Linux,
1836 * BSD and OS X) and Windows. On other platforms, you can either disable that
Jamie Fox92371712020-01-17 15:12:13 +00001837 * module and provide your own implementations of the callbacks needed by Mbed
1838 * TLS's \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and
1839 * provide your own implementation of the whole module by setting
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001840 * \c MBEDTLS_TIMING_ALT in the current file.
1841 *
1842 * \note See also our Knowledge Base article about porting to a new
1843 * environment:
1844 * https://tls.mbed.org/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS
1845 *
1846 * Module: library/timing.c
1847 * Caller: library/havege.c
1848 *
1849 * This module is used by the HAVEGE random number generator.
1850 */
1851//#define MBEDTLS_TIMING_C
1852
1853/**
1854 * \def MBEDTLS_VERSION_C
1855 *
1856 * Enable run-time version information.
1857 *
1858 * Module: library/version.c
1859 *
1860 * This module provides run-time version information.
1861 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001862//#define MBEDTLS_VERSION_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001863
1864/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001865 * \def MBEDTLS_XTEA_C
1866 *
1867 * Enable the XTEA block cipher.
1868 *
1869 * Module: library/xtea.c
1870 * Caller:
1871 */
Antonio de Angelisa27bfb52019-05-03 15:49:02 +01001872//#define MBEDTLS_XTEA_C
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001873
1874/* \} name SECTION: mbed TLS modules */
1875
1876/**
1877 * \name SECTION: Module configuration options
1878 *
1879 * This section allows for the setting of module specific sizes and
1880 * configuration options. The default values are already present in the
1881 * relevant header files and should suffice for the regular use cases.
1882 *
1883 * Our advice is to enable options and change their values here
1884 * only if you have a good reason and know the consequences.
1885 *
1886 * Please check the respective header file for documentation on these
1887 * parameters (to prevent duplicate documentation).
1888 * \{
1889 */
1890
1891/* MPI / BIGNUM options */
1892//#define MBEDTLS_MPI_WINDOW_SIZE 6 /**< Maximum windows size used. */
1893//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */
1894
1895/* CTR_DRBG options */
1896//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */
1897//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1898//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1899//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1900//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
1901//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY /**< Use 128-bit key for CTR_DRBG - may reduce security (see ctr_drbg.h) */
1902
1903/* HMAC_DRBG options */
1904//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */
1905//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */
1906//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */
1907//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */
1908
1909/* ECP options */
1910//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups */
1911//#define MBEDTLS_ECP_WINDOW_SIZE 6 /**< Maximum window size used */
1912//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */
1913
1914/* Entropy options */
1915//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */
1916//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */
1917//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32 /**< Default minimum number of bytes required for the hardware entropy source mbedtls_hardware_poll() before entropy is released */
1918
1919/* Memory buffer allocator options */
1920//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */
1921
1922/* Platform options */
1923//#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. */
1924//#define MBEDTLS_PLATFORM_STD_CALLOC calloc /**< Default allocator to use, can be undefined */
1925//#define MBEDTLS_PLATFORM_STD_FREE free /**< Default free to use, can be undefined */
1926//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */
1927//#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1928//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */
1929//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */
1930/* Note: your snprintf must correctly zero-terminate the buffer! */
1931//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */
1932//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */
1933//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */
1934//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
1935//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
1936//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */
1937
1938/* To Use Function Macros MBEDTLS_PLATFORM_C must be enabled */
1939/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */
1940//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined */
1941//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined */
1942//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */
1943//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1944//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */
1945//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */
1946//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */
1947/* Note: your snprintf must correctly zero-terminate the buffer! */
1948//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */
1949//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */
1950//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */
1951//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */
1952
1953/**
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001954 * Uncomment the macro to let mbed TLS use your alternate implementation of
1955 * mbedtls_platform_zeroize(). This replaces the default implementation in
1956 * platform_util.c.
1957 *
1958 * mbedtls_platform_zeroize() is a widely used function across the library to
1959 * zero a block of memory. The implementation is expected to be secure in the
1960 * sense that it has been written to prevent the compiler from removing calls
1961 * to mbedtls_platform_zeroize() as part of redundant code elimination
1962 * optimizations. However, it is difficult to guarantee that calls to
1963 * mbedtls_platform_zeroize() will not be optimized by the compiler as older
1964 * versions of the C language standards do not provide a secure implementation
1965 * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to
1966 * configure their own implementation of mbedtls_platform_zeroize(), for
1967 * example by using directives specific to their compiler, features from newer
1968 * C standards (e.g using memset_s() in C11) or calling a secure memset() from
1969 * their system (e.g explicit_bzero() in BSD).
1970 */
1971//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
1972
1973/**
1974 * Uncomment the macro to let Mbed TLS use your alternate implementation of
1975 * mbedtls_platform_gmtime_r(). This replaces the default implementation in
1976 * platform_util.c.
1977 *
1978 * gmtime() is not a thread-safe function as defined in the C standard. The
1979 * library will try to use safer implementations of this function, such as
1980 * gmtime_r() when available. However, if Mbed TLS cannot identify the target
1981 * system, the implementation of mbedtls_platform_gmtime_r() will default to
1982 * using the standard gmtime(). In this case, calls from the library to
1983 * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex
1984 * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the
1985 * library are also guarded with this mutex to avoid race conditions. However,
1986 * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will
1987 * unconditionally use the implementation for mbedtls_platform_gmtime_r()
1988 * supplied at compile time.
1989 */
1990//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
1991
Jamie Fox92371712020-01-17 15:12:13 +00001992/* \} name SECTION: Customisation configuration options */
1993
Raef Colesd2485af2019-10-30 10:15:33 +00001994#ifdef CRYPTO_HW_ACCELERATOR
1995#include "mbedtls_accelerator_config.h"
1996#endif
1997
Jamie Fox0e54ebc2019-04-09 14:21:04 +01001998/* Target and application specific configurations
1999 *
2000 * Allow user to override any previous default.
2001 *
2002 */
2003#if defined(MBEDTLS_USER_CONFIG_FILE)
2004#include MBEDTLS_USER_CONFIG_FILE
2005#endif
2006
2007#include "mbedtls/check_config.h"
2008
2009#endif /* MBEDTLS_CONFIG_H */