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