1 /* 2 * Copyright The TrustedFirmware-M Contributors 3 * 4 * SPDX-License-Identifier: BSD-3-Clause 5 * 6 */ 7 /** 8 * \file config.h 9 * 10 * \brief Configuration options (set of defines) 11 * 12 * This set of compile-time options may be used to enable 13 * or disable features selectively, and reduce the global 14 * memory footprint. 15 */ 16 17 #ifndef PROFILE_L_MBEDTLS_CONFIG_H 18 #define PROFILE_L_MBEDTLS_CONFIG_H 19 20 #include "config_tfm.h" 21 22 #if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE) 23 #define _CRT_SECURE_NO_DEPRECATE 1 24 #endif 25 26 /** 27 * \name SECTION: System support 28 * 29 * This section sets system specific settings. 30 * \{ 31 */ 32 33 /** 34 * \def MBEDTLS_HAVE_ASM 35 * 36 * The compiler has support for asm(). 37 * 38 * Requires support for asm() in compiler. 39 * 40 * Used in: 41 * library/aria.c 42 * library/timing.c 43 * include/mbedtls/bn_mul.h 44 * 45 * Required by: 46 * MBEDTLS_AESNI_C 47 * MBEDTLS_PADLOCK_C 48 * 49 * Comment to disable the use of assembly code. 50 */ 51 #define MBEDTLS_HAVE_ASM 52 53 /** 54 * \def MBEDTLS_PLATFORM_MEMORY 55 * 56 * Enable the memory allocation layer. 57 * 58 * By default mbed TLS uses the system-provided calloc() and free(). 59 * This allows different allocators (self-implemented or provided) to be 60 * provided to the platform abstraction layer. 61 * 62 * Enabling MBEDTLS_PLATFORM_MEMORY without the 63 * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide 64 * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and 65 * free() function pointer at runtime. 66 * 67 * Enabling MBEDTLS_PLATFORM_MEMORY and specifying 68 * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the 69 * alternate function at compile time. 70 * 71 * Requires: MBEDTLS_PLATFORM_C 72 * 73 * Enable this layer to allow use of alternative memory allocators. 74 */ 75 #define MBEDTLS_PLATFORM_MEMORY 76 77 /* \} name SECTION: System support */ 78 79 /** 80 * \name SECTION: mbed TLS feature support 81 * 82 * This section sets support for features that are or are not needed 83 * within the modules that are enabled. 84 * \{ 85 */ 86 87 /** 88 * \def MBEDTLS_AES_ROM_TABLES 89 * 90 * Use precomputed AES tables stored in ROM. 91 * 92 * Uncomment this macro to use precomputed AES tables stored in ROM. 93 * Comment this macro to generate AES tables in RAM at runtime. 94 * 95 * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb 96 * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the 97 * initialization time before the first AES operation can be performed. 98 * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c 99 * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded 100 * performance if ROM access is slower than RAM access. 101 * 102 * This option is independent of \c MBEDTLS_AES_FEWER_TABLES. 103 * 104 */ 105 #define MBEDTLS_AES_ROM_TABLES 106 107 /** 108 * \def MBEDTLS_AES_FEWER_TABLES 109 * 110 * Use less ROM/RAM for AES tables. 111 * 112 * Uncommenting this macro omits 75% of the AES tables from 113 * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES) 114 * by computing their values on the fly during operations 115 * (the tables are entry-wise rotations of one another). 116 * 117 * Tradeoff: Uncommenting this reduces the RAM / ROM footprint 118 * by ~6kb but at the cost of more arithmetic operations during 119 * runtime. Specifically, one has to compare 4 accesses within 120 * different tables to 4 accesses with additional arithmetic 121 * operations within the same table. The performance gain/loss 122 * depends on the system and memory details. 123 * 124 * This option is independent of \c MBEDTLS_AES_ROM_TABLES. 125 * 126 */ 127 #define MBEDTLS_AES_FEWER_TABLES 128 129 /** 130 * \def MBEDTLS_ECP_NIST_OPTIM 131 * 132 * Enable specific 'modulo p' routines for each NIST prime. 133 * Depending on the prime and architecture, makes operations 4 to 8 times 134 * faster on the corresponding curve. 135 * 136 * Comment this macro to disable NIST curves optimisation. 137 */ 138 #define MBEDTLS_ECP_NIST_OPTIM 139 140 /** 141 * \def MBEDTLS_NO_PLATFORM_ENTROPY 142 * 143 * Do not use built-in platform entropy functions. 144 * This is useful if your platform does not support 145 * standards like the /dev/urandom or Windows CryptoAPI. 146 * 147 * Uncomment this macro to disable the built-in platform entropy functions. 148 */ 149 #define MBEDTLS_NO_PLATFORM_ENTROPY 150 151 /** 152 * \def MBEDTLS_ENTROPY_NV_SEED 153 * 154 * Enable the non-volatile (NV) seed file-based entropy source. 155 * (Also enables the NV seed read/write functions in the platform layer) 156 * 157 * This is crucial (if not required) on systems that do not have a 158 * cryptographic entropy source (in hardware or kernel) available. 159 * 160 * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C 161 * 162 * \note The read/write functions that are used by the entropy source are 163 * determined in the platform layer, and can be modified at runtime and/or 164 * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used. 165 * 166 * \note If you use the default implementation functions that read a seedfile 167 * with regular fopen(), please make sure you make a seedfile with the 168 * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at 169 * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from 170 * and written to or you will get an entropy source error! The default 171 * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE 172 * bytes from the file. 173 * 174 * \note The entropy collector will write to the seed file before entropy is 175 * given to an external source, to update it. 176 */ 177 //#define MBEDTLS_ENTROPY_NV_SEED 178 179 /** 180 * \def MBEDTLS_PK_RSA_ALT_SUPPORT 181 * 182 * Support external private RSA keys (eg from a HSM) in the PK layer. 183 * 184 * Comment this macro to disable support for external private RSA keys. 185 */ 186 #define MBEDTLS_PK_RSA_ALT_SUPPORT 187 188 /** \def MBEDTLS_PSA_CRYPTO_CLIENT 189 * 190 * Enable support for PSA crypto client. 191 * 192 * \note This option allows to include the code necessary for a PSA 193 * crypto client when the PSA crypto implementation is not included in 194 * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the 195 * code to set and get PSA key attributes. 196 * The development of PSA drivers partially relying on the library to 197 * fulfill the hardware gaps is another possible usage of this option. 198 * 199 * \warning This interface is experimental and may change or be removed 200 * without notice. 201 */ 202 #define MBEDTLS_PSA_CRYPTO_CLIENT 203 204 /** 205 * \def MBEDTLS_PSA_CRYPTO_CONFIG 206 * 207 * This setting allows support for cryptographic mechanisms through the PSA 208 * API to be configured separately from support through the mbedtls API. 209 * 210 * When this option is disabled, the PSA API exposes the cryptographic 211 * mechanisms that can be implemented on top of the `mbedtls_xxx` API 212 * configured with `MBEDTLS_XXX` symbols. 213 * 214 * When this option is enabled, the PSA API exposes the cryptographic 215 * mechanisms requested by the `PSA_WANT_XXX` symbols defined in 216 * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are 217 * automatically enabled if required (i.e. if no PSA driver provides the 218 * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols 219 * in mbedtls_config.h. 220 * 221 * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies 222 * an alternative header to include instead of include/psa/crypto_config.h. 223 * 224 * This feature is still experimental and is not ready for production since 225 * it is not completed. 226 */ 227 #define MBEDTLS_PSA_CRYPTO_CONFIG 228 229 /* \} name SECTION: mbed TLS feature support */ 230 231 /** 232 * \name SECTION: mbed TLS modules 233 * 234 * This section enables or disables entire modules in mbed TLS 235 * \{ 236 */ 237 238 /** 239 * \def MBEDTLS_AES_C 240 * 241 * Enable the AES block cipher. 242 * 243 * Module: library/aes.c 244 * Caller: library/cipher.c 245 * library/pem.c 246 * library/ctr_drbg.c 247 * 248 * This module is required to support the TLS ciphersuites that use the AES 249 * cipher. 250 * 251 * PEM_PARSE uses AES for decrypting encrypted keys. 252 */ 253 #define MBEDTLS_AES_C 254 255 /** 256 * \def MBEDTLS_CIPHER_C 257 * 258 * Enable the generic cipher layer. 259 * 260 * Module: library/cipher.c 261 * 262 * Uncomment to enable generic cipher wrappers. 263 */ 264 #define MBEDTLS_CIPHER_C 265 266 /** 267 * \def MBEDTLS_CTR_DRBG_C 268 * 269 * Enable the CTR_DRBG AES-based random generator. 270 * The CTR_DRBG generator uses AES-256 by default. 271 * To use AES-128 instead, enable MBEDTLS_CTR_DRBG_USE_128_BIT_KEY below. 272 * 273 * Module: library/ctr_drbg.c 274 * Caller: 275 * 276 * Requires: MBEDTLS_AES_C 277 * 278 * This module provides the CTR_DRBG AES random number generator. 279 */ 280 //#define MBEDTLS_CTR_DRBG_C 281 282 /** 283 * \def MBEDTLS_ENTROPY_C 284 * 285 * Enable the platform-specific entropy code. 286 * 287 * Module: library/entropy.c 288 * Caller: 289 * 290 * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C 291 * 292 * This module provides a generic entropy pool 293 */ 294 //#define MBEDTLS_ENTROPY_C 295 296 /** 297 * \def MBEDTLS_HKDF_C 298 * 299 * Enable the HKDF algorithm (RFC 5869). 300 * 301 * Module: library/hkdf.c 302 * Caller: 303 * 304 * Requires: MBEDTLS_MD_C 305 * 306 * This module adds support for the Hashed Message Authentication Code 307 * (HMAC)-based key derivation function (HKDF). 308 */ 309 //#define MBEDTLS_HKDF_C /* Used for HUK deriviation */ 310 311 /** 312 * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C 313 * 314 * Enable the buffer allocator implementation that makes use of a (stack) 315 * based buffer to 'allocate' dynamic memory. (replaces calloc() and free() 316 * calls) 317 * 318 * Module: library/memory_buffer_alloc.c 319 * 320 * Requires: MBEDTLS_PLATFORM_C 321 * MBEDTLS_PLATFORM_MEMORY (to use it within mbed TLS) 322 * 323 * Enable this module to enable the buffer memory allocator. 324 */ 325 #define MBEDTLS_MEMORY_BUFFER_ALLOC_C 326 327 /** 328 * \def MBEDTLS_PLATFORM_C 329 * 330 * Enable the platform abstraction layer that allows you to re-assign 331 * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit(). 332 * 333 * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT 334 * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned 335 * above to be specified at runtime or compile time respectively. 336 * 337 * \note This abstraction layer must be enabled on Windows (including MSYS2) 338 * as other module rely on it for a fixed snprintf implementation. 339 * 340 * Module: library/platform.c 341 * Caller: Most other .c files 342 * 343 * This module enables abstraction of common (libc) functions. 344 */ 345 #define MBEDTLS_PLATFORM_C 346 347 #define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS 348 #define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h> 349 350 #include <stdio.h> 351 352 #define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf 353 #define MBEDTLS_PLATFORM_PRINTF_ALT 354 #define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS EXIT_SUCCESS 355 #define MBEDTLS_PLATFORM_STD_EXIT_FAILURE EXIT_FAILURE 356 357 /** 358 * \def MBEDTLS_PSA_CRYPTO_C 359 * 360 * Enable the Platform Security Architecture cryptography API. 361 * 362 * Module: library/psa_crypto.c 363 * 364 * Requires: MBEDTLS_CTR_DRBG_C, MBEDTLS_ENTROPY_C 365 * 366 */ 367 //#define MBEDTLS_PSA_CRYPTO_C 368 369 /** 370 * \def MBEDTLS_PSA_CRYPTO_STORAGE_C 371 * 372 * Enable the Platform Security Architecture persistent key storage. 373 * 374 * Module: library/psa_crypto_storage.c 375 * 376 * Requires: MBEDTLS_PSA_CRYPTO_C, 377 * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of 378 * the PSA ITS interface 379 */ 380 //#define MBEDTLS_PSA_CRYPTO_STORAGE_C 381 382 /* \} name SECTION: mbed TLS modules */ 383 384 /** 385 * \name SECTION: General configuration options 386 * 387 * This section contains Mbed TLS build settings that are not associated 388 * with a particular module. 389 * 390 * \{ 391 */ 392 393 /** 394 * \def MBEDTLS_CONFIG_FILE 395 * 396 * If defined, this is a header which will be included instead of 397 * `"mbedtls/mbedtls_config.h"`. 398 * This header file specifies the compile-time configuration of Mbed TLS. 399 * Unlike other configuration options, this one must be defined on the 400 * compiler command line: a definition in `mbedtls_config.h` would have 401 * no effect. 402 * 403 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but 404 * non-standard feature of the C language, so this feature is only available 405 * with compilers that perform macro expansion on an <tt>\#include</tt> line. 406 * 407 * The value of this symbol is typically a path in double quotes, either 408 * absolute or relative to a directory on the include search path. 409 */ 410 //#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h" 411 412 /** 413 * \def MBEDTLS_USER_CONFIG_FILE 414 * 415 * If defined, this is a header which will be included after 416 * `"mbedtls/mbedtls_config.h"` or #MBEDTLS_CONFIG_FILE. 417 * This allows you to modify the default configuration, including the ability 418 * to undefine options that are enabled by default. 419 * 420 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but 421 * non-standard feature of the C language, so this feature is only available 422 * with compilers that perform macro expansion on an <tt>\#include</tt> line. 423 * 424 * The value of this symbol is typically a path in double quotes, either 425 * absolute or relative to a directory on the include search path. 426 */ 427 //#define MBEDTLS_USER_CONFIG_FILE "/dev/null" 428 429 /** 430 * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE 431 * 432 * If defined, this is a header which will be included instead of 433 * `"psa/crypto_config.h"`. 434 * This header file specifies which cryptographic mechanisms are available 435 * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and 436 * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled. 437 * 438 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but 439 * non-standard feature of the C language, so this feature is only available 440 * with compilers that perform macro expansion on an <tt>\#include</tt> line. 441 * 442 * The value of this symbol is typically a path in double quotes, either 443 * absolute or relative to a directory on the include search path. 444 */ 445 //#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h" 446 447 /** 448 * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE 449 * 450 * If defined, this is a header which will be included after 451 * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE. 452 * This allows you to modify the default configuration, including the ability 453 * to undefine options that are enabled by default. 454 * 455 * This macro is expanded after an <tt>\#include</tt> directive. This is a popular but 456 * non-standard feature of the C language, so this feature is only available 457 * with compilers that perform macro expansion on an <tt>\#include</tt> line. 458 * 459 * The value of this symbol is typically a path in double quotes, either 460 * absolute or relative to a directory on the include search path. 461 */ 462 //#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null" 463 464 /** \} name SECTION: General configuration options */ 465 466 /** 467 * \name SECTION: Module configuration options 468 * 469 * This section allows for the setting of module specific sizes and 470 * configuration options. The default values are already present in the 471 * relevant header files and should suffice for the regular use cases. 472 * 473 * Our advice is to enable options and change their values here 474 * only if you have a good reason and know the consequences. 475 * 476 * Please check the respective header file for documentation on these 477 * parameters (to prevent duplicate documentation). 478 * \{ 479 */ 480 481 /* ECP options */ 482 #define MBEDTLS_ECP_FIXED_POINT_OPTIM 0 /**< Disable fixed-point speed-up */ 483 484 /* \} name SECTION: Customisation configuration options */ 485 486 #endif /* PROFILE_L_MBEDTLS_CONFIG_H */ 487
