blob: b26aa8470e72a8a0286bbee6f49cd82a7bbea292 [file] [log] [blame] [view]
Ronald Cron5e292602024-09-03 16:01:48 +02001Configuration file split
2========================
Ronald Cron8793d9c2024-06-06 17:54:45 +02003
Ronald Cron4162c3a2024-09-19 11:05:56 +02004## Why split the configuration file?
Ronald Cron8793d9c2024-06-06 17:54:45 +02005
6The objective of the repository split is to reach the point where in Mbed TLS
Ronald Cron4162c3a2024-09-19 11:05:56 +02007all the cryptography code and its tests are located in a `tf-psa-crypto`
Ronald Cron8793d9c2024-06-06 17:54:45 +02008directory that just contains the TF-PSA-Crypto repository as a submodule.
9The cryptography APIs exposed by Mbed TLS are just the TF-PSA-Crypto ones.
10Mbed TLS relies solely on the TF-PSA-Crypto build system to build its
11cryptography library and its tests.
12
Ronald Cron075c7422024-09-09 15:43:38 +020013The TF-PSA-Crypto configuration file `tf_psa_crypto_config.h` configures
Ronald Cron8793d9c2024-06-06 17:54:45 +020014entirely the cryptography interface exposed by Mbed TLS through TF-PSA-Crypto.
Ronald Cron4162c3a2024-09-19 11:05:56 +020015Mbed TLS configuration is split in two files: `mbedtls_config.h` for TLS and
Ronald Cron075c7422024-09-09 15:43:38 +020016x509, `tf_psa_crypto_config.h` for the cryptography.
Ronald Cron8793d9c2024-06-06 17:54:45 +020017
Ronald Cron5e292602024-09-03 16:01:48 +020018## How do we split the configuration file?
Ronald Cron8793d9c2024-06-06 17:54:45 +020019
Ronald Cron4162c3a2024-09-19 11:05:56 +020020We extend the so-called PSA cryptographic configuration scheme based on
Ronald Cron075c7422024-09-09 15:43:38 +020021`mbedtls_config.h` and `crypto_config.h`. The configuration file `crypto_config.h`
22is extended to become the TF-PSA-Crypto configuration file, `mbedtls_config.h`
Ronald Cron5e292602024-09-03 16:01:48 +020023becomes the configuration file for the TLS and x509 libraries. All the options
24to select the cryptographic mechanisms and to configure their implementation
Ronald Cron075c7422024-09-09 15:43:38 +020025are moved from `mbedtls_config.h` to `(tf_psa_)crypto_config.h`.
Ronald Cron8793d9c2024-06-06 17:54:45 +020026
Ronald Cron5e292602024-09-03 16:01:48 +020027The configuration options that are relevant to both Mbed TLS and TF-PSA-Crypto
Ronald Cron075c7422024-09-09 15:43:38 +020028like platform or system ones are moved to `(tf_psa_)crypto_config.h`. That way
Ronald Cron5e292602024-09-03 16:01:48 +020029they are available in both repositories (as Mbed TLS includes
Ronald Cron075c7422024-09-09 15:43:38 +020030`tf_psa_crypto_config.h`) without duplication. Later, we may duplicate or
31create aliases for some of them to align with the naming conventions of the
Ronald Cron5e292602024-09-03 16:01:48 +020032repositories.
Ronald Cron8793d9c2024-06-06 17:54:45 +020033
Ronald Cron075c7422024-09-09 15:43:38 +020034The layout of options into sections in `mbedtls_config.h` does not suit
35TF-PSA-Crypto well thus the configuration options `tf_psa_crypto_config.h` are
Ronald Cron5e292602024-09-03 16:01:48 +020036organized into different sections (see below).
37
Ronald Cron075c7422024-09-09 15:43:38 +020038## Configuration files and `config.py`
Ronald Cron5e292602024-09-03 16:01:48 +020039
Ronald Cron075c7422024-09-09 15:43:38 +020040Each repository contains a `config.py` script to create and modify
41configurations.
Ronald Cron5e292602024-09-03 16:01:48 +020042
Ronald Cron075c7422024-09-09 15:43:38 +020043In Mbed TLS, `config.py` handles both `mbedtls_config.h` and
44`tf_psa_crypto_config.h`. It can set or unset TLS, x509 and cryptographic
Ronald Cron5e292602024-09-03 16:01:48 +020045configuration options without having to specify the configuration file the
46options belong to. Commands like full and baremetal affect both configuration
47files.
48
Ronald Cron075c7422024-09-09 15:43:38 +020049In TF-PSA-Crypto, `config.py` addresses only `tf_psa_crypto_config.h`.
Ronald Cron8793d9c2024-06-06 17:54:45 +020050
Ronald Cron075c7422024-09-09 15:43:38 +020051## Sections in `tf_psa_crypto_config.h`
Ronald Cron8793d9c2024-06-06 17:54:45 +020052
Ronald Cron075c7422024-09-09 15:43:38 +020053The `tf_psa_crypto_config.h` configuration file is organized into eight
54sections.
Ronald Cron8793d9c2024-06-06 17:54:45 +020055
Ronald Cron075c7422024-09-09 15:43:38 +020056The pre-split `mbedtls_config.h` configuration file contains configuration
Ronald Cron8793d9c2024-06-06 17:54:45 +020057options that apply to the whole code base (TLS, x509, crypto and tests) mostly
Ronald Cron075c7422024-09-09 15:43:38 +020058related to the platform abstraction layer and testing. In
59`tf_psa_crypto_config.h` these configurations options are organized into two
60sections, one for the platform abstraction layer options and one for the others,
Ronald Cron2c152fd2024-09-27 10:30:59 +020061respectively named ["Platform abstraction layer"](#section-platform-abstraction-layer)
62and ["General and test configuration options"](#section-general-and-test-configuration-options).
Ronald Cron8793d9c2024-06-06 17:54:45 +020063
Ronald Cron2c152fd2024-09-27 10:30:59 +020064Then, the ["Cryptographic mechanism selection (PSA API)"](#section-cryptographic-mechanism-selection-PSA-API)
65section is the equivalent of the pre-split `crypto_config.h` configuration file
66containing the PSA_WANT_ prefixed macros.
Ronald Cron8793d9c2024-06-06 17:54:45 +020067
Ronald Cron2c152fd2024-09-27 10:30:59 +020068The following section named
69["Cryptographic mechanism selection (extended API)"](#section-cryptographic-mechanism-selection-extended-API)
Ronald Cron8e1b4632024-09-02 16:21:44 +020070contains the configuration options for the cryptography mechanisms that are not
71yet part of the PSA cryptography API (like LMS or PK).
72
Ronald Cron2c152fd2024-09-27 10:30:59 +020073It is followed by the ["Data format support"](#section-data-format-support)
74section that contains configuration options of utilities related to various data
75formats (like Base64 or ASN.1 APIs). These utilities aim to facilitate the
76usage of the PSA cryptography API in other cryptography projects.
Ronald Cron8e1b4632024-09-02 16:21:44 +020077
Ronald Cron8793d9c2024-06-06 17:54:45 +020078Compared to Mbed TLS, the cryptography code in TF-PSA-Crypto is not located
79in a single directory but split between the PSA core (core directory) and the
80PSA builtin drivers (drivers/builtin/src directory). This is reflected in
Ronald Cron2c152fd2024-09-27 10:30:59 +020081`tf_psa_crypto_config.h` with two sections respectively named ["PSA core"](#section-psa-core)
82and ["Builtin drivers"](#section-builtin-drivers).
Ronald Cron8793d9c2024-06-06 17:54:45 +020083
Ronald Cron2c152fd2024-09-27 10:30:59 +020084Finally, the last section named ["Legacy cryptography"](#section-legacy-cryptography)
85contains the configuration options that will eventually be removed as duplicates
86of PSA_WANT_\* and MBEDTLS_PSA_ACCEL_\* configuration options.
Ronald Cronad62dce2024-09-02 14:22:24 +020087
Ronald Cron075c7422024-09-09 15:43:38 +020088By contrast to `mbedtls_config.h`, `tf_psa_crypto_config.h` does not contain a
Ronald Cron8793d9c2024-06-06 17:54:45 +020089section like the "Module configuration options" one containing non boolean
90configuration options. The configuration options that are not boolean are
91located in the same section as the boolean option they are associated to.
92
Ronald Cron8793d9c2024-06-06 17:54:45 +020093## Repartition of the configuration options
94
Ronald Cron075c7422024-09-09 15:43:38 +020095### In `tf_psa_crypto_config.h`, we have:
Ronald Cron2c152fd2024-09-27 10:30:59 +020096#### SECTION Platform abstraction layer
Ronald Crona5a46d02024-09-10 09:40:59 +020097```
Ronald Cronf50ae422024-09-09 16:04:23 +020098#define MBEDTLS_FS_IO
Ronald Crona3f3fca2024-09-02 12:09:18 +020099#define MBEDTLS_HAVE_TIME
100#define MBEDTLS_HAVE_TIME_DATE
Ronald Crona3f3fca2024-09-02 12:09:18 +0200101//#define MBEDTLS_MEMORY_BACKTRACE
Ronald Cron294b5e02024-09-27 10:04:31 +0200102//#define MBEDTLS_MEMORY_DEBUG
Ronald Cronf50ae422024-09-09 16:04:23 +0200103#define MBEDTLS_PLATFORM_C
104//#define MBEDTLS_PLATFORM_EXIT_ALT
105//#define MBEDTLS_PLATFORM_FPRINTF_ALT
106//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
107//#define MBEDTLS_PLATFORM_MEMORY
108//#define MBEDTLS_PLATFORM_MS_TIME_ALT
109//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
110//#define MBEDTLS_PLATFORM_NV_SEED_ALT
111//#define MBEDTLS_PLATFORM_PRINTF_ALT
112//#define MBEDTLS_PLATFORM_SETBUF_ALT
113//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
114//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
115//#define MBEDTLS_PLATFORM_TIME_ALT
116//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
117//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Ronald Cron4f4a30c2024-09-02 15:00:54 +0200118//#define MBEDTLS_THREADING_ALT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200119//#define MBEDTLS_THREADING_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200120//#define MBEDTLS_THREADING_PTHREAD
Ronald Cronf50ae422024-09-09 16:04:23 +0200121
122//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
Ronald Crona3f3fca2024-09-02 12:09:18 +0200123//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc
Ronald Crona3f3fca2024-09-02 12:09:18 +0200124//#define MBEDTLS_PLATFORM_EXIT_MACRO exit
Ronald Cronf50ae422024-09-09 16:04:23 +0200125//#define MBEDTLS_PLATFORM_FREE_MACRO free
Ronald Crona3f3fca2024-09-02 12:09:18 +0200126//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf
Ronald Crona3f3fca2024-09-02 12:09:18 +0200127//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t
Ronald Cronf50ae422024-09-09 16:04:23 +0200128//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read
129//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write
130//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf
131//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf
Ronald Cron294b5e02024-09-27 10:04:31 +0200132//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf
Ronald Cronf50ae422024-09-09 16:04:23 +0200133//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
134//#define MBEDTLS_PLATFORM_STD_EXIT exit
135//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1
136//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0
137//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf
138//#define MBEDTLS_PLATFORM_STD_FREE free
139//#define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h>
140//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile"
141//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read
142//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write
143//#define MBEDTLS_PLATFORM_STD_PRINTF printf
144//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf
145//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf
146//#define MBEDTLS_PLATFORM_STD_TIME time
Ronald Cronf50ae422024-09-09 16:04:23 +0200147//#define MBEDTLS_PLATFORM_TIME_MACRO time
148//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t
149//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf
Ronald Cron294b5e02024-09-27 10:04:31 +0200150//#define MBEDTLS_PRINTF_MS_TIME PRId64
Ronald Crona5a46d02024-09-10 09:40:59 +0200151```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200152
Ronald Cron2c152fd2024-09-27 10:30:59 +0200153#### SECTION General and test configuration options
Ronald Crona5a46d02024-09-10 09:40:59 +0200154```
Ronald Cronf50ae422024-09-09 16:04:23 +0200155//#define MBEDTLS_CHECK_RETURN_WARNING
156//#define MBEDTLS_DEPRECATED_REMOVED
157//#define MBEDTLS_DEPRECATED_WARNING
Ronald Cron717663b2024-09-02 15:30:10 +0200158#define MBEDTLS_SELF_TEST
Ronald Crona3f3fca2024-09-02 12:09:18 +0200159//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
160//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
161//#define MBEDTLS_TEST_HOOKS
Ronald Cron8793d9c2024-06-06 17:54:45 +0200162
Ronald Crone5d0f8c2024-09-02 15:43:10 +0200163//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
164//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
Ronald Cron294b5e02024-09-27 10:04:31 +0200165//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h"
166//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
Ronald Crona5a46d02024-09-10 09:40:59 +0200167```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200168
Ronald Cron2c152fd2024-09-27 10:30:59 +0200169#### SECTION Cryptographic mechanism selection (PSA API)
Ronald Cron075c7422024-09-09 15:43:38 +0200170PSA_WANT_\* macros as in current `crypto_config.h`.
Ronald Cron8793d9c2024-06-06 17:54:45 +0200171
172
Ronald Cron2c152fd2024-09-27 10:30:59 +0200173#### SECTION Cryptographic mechanism selection (extended API)
Ronald Crona5a46d02024-09-10 09:40:59 +0200174```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200175#define MBEDTLS_LMS_C
176//#define MBEDTLS_LMS_PRIVATE
177#define MBEDTLS_MD_C
178#define MBEDTLS_NIST_KW_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200179#define MBEDTLS_PKCS5_C
180#define MBEDTLS_PKCS12_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200181#define MBEDTLS_PK_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200182#define MBEDTLS_PK_PARSE_C
Ronald Cron8e1b4632024-09-02 16:21:44 +0200183#define MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron294b5e02024-09-27 10:04:31 +0200184#define MBEDTLS_PK_PARSE_EC_EXTENDED
Ronald Cron8e1b4632024-09-02 16:21:44 +0200185#define MBEDTLS_PK_RSA_ALT_SUPPORT
Ronald Cron8e1b4632024-09-02 16:21:44 +0200186#define MBEDTLS_PK_WRITE_C
Ronald Cron8e1b4632024-09-02 16:21:44 +0200187
Ronald Cron8e1b4632024-09-02 16:21:44 +0200188//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Ronald Cron8e1b4632024-09-02 16:21:44 +0200189//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
190//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
191//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Ronald Cronf50ae422024-09-09 16:04:23 +0200192//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
Ronald Cron8e1b4632024-09-02 16:21:44 +0200193//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
194//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
195//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
Ronald Cronf50ae422024-09-09 16:04:23 +0200196//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
197//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
Ronald Crona5a46d02024-09-10 09:40:59 +0200198```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200199
200
Ronald Cron2c152fd2024-09-27 10:30:59 +0200201#### SECTION Data format support
Ronald Crona5a46d02024-09-10 09:40:59 +0200202```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200203#define MBEDTLS_ASN1_PARSE_C
204#define MBEDTLS_ASN1_WRITE_C
205#define MBEDTLS_BASE64_C
206#define MBEDTLS_OID_C
207#define MBEDTLS_PEM_PARSE_C
208#define MBEDTLS_PEM_WRITE_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200209```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200210
211
Ronald Cron2c152fd2024-09-27 10:30:59 +0200212#### SECTION PSA core
Ronald Crona5a46d02024-09-10 09:40:59 +0200213```
Ronald Cronf50ae422024-09-09 16:04:23 +0200214#define MBEDTLS_ENTROPY_C
215//#define MBEDTLS_ENTROPY_FORCE_SHA256
Ronald Crona3f3fca2024-09-02 12:09:18 +0200216//#define MBEDTLS_ENTROPY_HARDWARE_ALT
Ronald Cronf50ae422024-09-09 16:04:23 +0200217//#define MBEDTLS_ENTROPY_NV_SEED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200218//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
219//#define MBEDTLS_NO_PLATFORM_ENTROPY
Ronald Cronf50ae422024-09-09 16:04:23 +0200220//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
221//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Ronald Cron294b5e02024-09-27 10:04:31 +0200222#define MBEDTLS_PSA_CRYPTO_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200223//#define MBEDTLS_PSA_CRYPTO_CLIENT
224//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Ronald Cronf50ae422024-09-09 16:04:23 +0200225//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200226//#define MBEDTLS_PSA_CRYPTO_SPM
Ronald Crona3f3fca2024-09-02 12:09:18 +0200227#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200228//#define MBEDTLS_PSA_INJECT_ENTROPY
Ronald Crona3f3fca2024-09-02 12:09:18 +0200229#define MBEDTLS_PSA_ITS_FILE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200230
Ronald Crona3f3fca2024-09-02 12:09:18 +0200231//#define MBEDTLS_ENTROPY_MAX_GATHER 128
Ronald Cron294b5e02024-09-27 10:04:31 +0200232//#define MBEDTLS_ENTROPY_MAX_SOURCES 20
Ronald Crona3f3fca2024-09-02 12:09:18 +0200233//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32
Ronald Cronf50ae422024-09-09 16:04:23 +0200234//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
235//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
236//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Ronald Crona5a46d02024-09-10 09:40:59 +0200237```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200238
Ronald Cron2c152fd2024-09-27 10:30:59 +0200239#### SECTION Builtin drivers
Ronald Crona5a46d02024-09-10 09:40:59 +0200240```
Ronald Crona3f3fca2024-09-02 12:09:18 +0200241#define MBEDTLS_AESCE_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200242#define MBEDTLS_AESNI_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200243//#define MBEDTLS_AES_FEWER_TABLES
244//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Ronald Cron294b5e02024-09-27 10:04:31 +0200245//#define MBEDTLS_AES_ROM_TABLES
Ronald Crona3f3fca2024-09-02 12:09:18 +0200246//#define MBEDTLS_AES_USE_HARDWARE_ONLY
Ronald Cronf50ae422024-09-09 16:04:23 +0200247//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200248//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
249//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
250#define MBEDTLS_ECP_NIST_OPTIM
Ronald Cron4f4a30c2024-09-02 15:00:54 +0200251//#define MBEDTLS_ECP_RESTARTABLE
Ronald Crona3f3fca2024-09-02 12:09:18 +0200252//#define MBEDTLS_ECP_WITH_MPI_UINT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200253//#define MBEDTLS_GCM_LARGE_TABLE
Ronald Cronf50ae422024-09-09 16:04:23 +0200254#define MBEDTLS_HAVE_ASM
255//#define MBEDTLS_HAVE_SSE2
256//#define MBEDTLS_NO_UDBL_DIVISION
257//#define MBEDTLS_NO_64BIT_MULTIPLICATION
258//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
259//#define MBEDTLS_RSA_NO_CRT
260//#define MBEDTLS_SHA256_SMALLER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200261//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200262//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Ronald Cron294b5e02024-09-27 10:04:31 +0200263//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
264//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Ronald Cronf50ae422024-09-09 16:04:23 +0200265//#define MBEDTLS_SHA512_SMALLER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200266//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
267//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Ronald Cronf50ae422024-09-09 16:04:23 +0200268
Ronald Crona3f3fca2024-09-02 12:09:18 +0200269//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1
Ronald Cronf50ae422024-09-09 16:04:23 +0200270//#define MBEDTLS_ECP_WINDOW_SIZE 4
271//#define MBEDTLS_MPI_MAX_SIZE 1024
272//#define MBEDTLS_MPI_WINDOW_SIZE 2
Ronald Crona3f3fca2024-09-02 12:09:18 +0200273//#define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024
Ronald Crona5a46d02024-09-10 09:40:59 +0200274```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200275
276
Ronald Cron2c152fd2024-09-27 10:30:59 +0200277#### SECTION Legacy cryptography
Ronald Crona5a46d02024-09-10 09:40:59 +0200278```
Ronald Cronf50ae422024-09-09 16:04:23 +0200279#define MBEDTLS_AES_C
280#define MBEDTLS_ARIA_C
281#define MBEDTLS_BIGNUM_C
282#define MBEDTLS_CAMELLIA_C
283#define MBEDTLS_CCM_C
284#define MBEDTLS_CHACHA20_C
285#define MBEDTLS_CHACHAPOLY_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200286#define MBEDTLS_CIPHER_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200287#define MBEDTLS_CIPHER_MODE_CBC
288#define MBEDTLS_CIPHER_MODE_CFB
289#define MBEDTLS_CIPHER_MODE_CTR
290#define MBEDTLS_CIPHER_MODE_OFB
291#define MBEDTLS_CIPHER_MODE_XTS
Ronald Cronad62dce2024-09-02 14:22:24 +0200292#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
Ronald Cron294b5e02024-09-27 10:04:31 +0200293#define MBEDTLS_CIPHER_PADDING_PKCS7
Ronald Cronad62dce2024-09-02 14:22:24 +0200294#define MBEDTLS_CIPHER_PADDING_ZEROS
Ronald Cron294b5e02024-09-27 10:04:31 +0200295#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
Ronald Cronf50ae422024-09-09 16:04:23 +0200296#define MBEDTLS_CMAC_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200297#define MBEDTLS_CTR_DRBG_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200298//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
299#define MBEDTLS_DES_C
300#define MBEDTLS_DHM_C
301#define MBEDTLS_ECDH_C
302#define MBEDTLS_ECP_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200303#define MBEDTLS_ECP_DP_BP256R1_ENABLED
304#define MBEDTLS_ECP_DP_BP384R1_ENABLED
305#define MBEDTLS_ECP_DP_BP512R1_ENABLED
306#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
307#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Ronald Cron294b5e02024-09-27 10:04:31 +0200308#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
309#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
310#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
311#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
312#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
313#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
314#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
315#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
Ronald Cronad62dce2024-09-02 14:22:24 +0200316#define MBEDTLS_ECDSA_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200317#define MBEDTLS_ECDSA_DETERMINISTIC
Ronald Cronad62dce2024-09-02 14:22:24 +0200318#define MBEDTLS_ECJPAKE_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200319#define MBEDTLS_GCM_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200320#define MBEDTLS_GENPRIME
Ronald Cronad62dce2024-09-02 14:22:24 +0200321#define MBEDTLS_HKDF_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200322#define MBEDTLS_HMAC_DRBG_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200323#define MBEDTLS_MD5_C
324#define MBEDTLS_PADLOCK_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200325#define MBEDTLS_PKCS1_V15
326#define MBEDTLS_PKCS1_V21
Ronald Cronad62dce2024-09-02 14:22:24 +0200327#define MBEDTLS_POLY1305_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200328//#define MBEDTLS_PSA_CRYPTO_CONFIG
Ronald Cronad62dce2024-09-02 14:22:24 +0200329//#define MBEDTLS_PSA_CRYPTO_SE_C
330#define MBEDTLS_RIPEMD160_C
331#define MBEDTLS_RSA_C
332#define MBEDTLS_SHA1_C
333#define MBEDTLS_SHA224_C
334#define MBEDTLS_SHA256_C
335#define MBEDTLS_SHA384_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200336#define MBEDTLS_SHA3_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200337#define MBEDTLS_SHA512_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200338```
Ronald Cronad62dce2024-09-02 14:22:24 +0200339
Ronald Cron8793d9c2024-06-06 17:54:45 +0200340
Ronald Cron075c7422024-09-09 15:43:38 +0200341### In `mbedtls_config.h`, we have:
Ronald Cron2c152fd2024-09-27 10:30:59 +0200342#### SECTION Platform abstraction layer
Ronald Crona5a46d02024-09-10 09:40:59 +0200343```
Ronald Cron34a40862024-09-02 15:33:45 +0200344#define MBEDTLS_NET_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200345//#define MBEDTLS_TIMING_ALT
Ronald Cron294b5e02024-09-27 10:04:31 +0200346#define MBEDTLS_TIMING_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200347```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200348
349
Ronald Cron2c152fd2024-09-27 10:30:59 +0200350#### SECTION Mbed TLS feature support
Ronald Crona5a46d02024-09-10 09:40:59 +0200351```
Ronald Crona3f3fca2024-09-02 12:09:18 +0200352//#define MBEDTLS_CIPHER_NULL_CIPHER
Ronald Cronf50ae422024-09-09 16:04:23 +0200353#define MBEDTLS_ERROR_STRERROR_DUMMY
Ronald Crona3f3fca2024-09-02 12:09:18 +0200354#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200355#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200356#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
Ronald Cron294b5e02024-09-27 10:04:31 +0200357#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
358#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200359#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
360#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
361//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
Ronald Cron294b5e02024-09-27 10:04:31 +0200362#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
363#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
364#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200365#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
Ronald Cronf50ae422024-09-09 16:04:23 +0200366#define MBEDTLS_SSL_ALPN
Ronald Crona3f3fca2024-09-02 12:09:18 +0200367//#define MBEDTLS_SSL_ASYNC_PRIVATE
368#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
369//#define MBEDTLS_SSL_DEBUG_ALL
Ronald Cronf50ae422024-09-09 16:04:23 +0200370#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
371#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
372#define MBEDTLS_SSL_DTLS_CONNECTION_ID
373#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
374#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
375//#define MBEDTLS_SSL_DTLS_SRTP
Ronald Cronf50ae422024-09-09 16:04:23 +0200376//#define MBEDTLS_SSL_EARLY_DATA
Ronald Cron294b5e02024-09-27 10:04:31 +0200377#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
Ronald Crona3f3fca2024-09-02 12:09:18 +0200378#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
379#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
Ronald Crona3f3fca2024-09-02 12:09:18 +0200380#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
Ronald Cronf50ae422024-09-09 16:04:23 +0200381#define MBEDTLS_SSL_PROTO_DTLS
Ronald Crona3f3fca2024-09-02 12:09:18 +0200382#define MBEDTLS_SSL_PROTO_TLS1_2
383#define MBEDTLS_SSL_PROTO_TLS1_3
Ronald Cron294b5e02024-09-27 10:04:31 +0200384//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
385#define MBEDTLS_SSL_RENEGOTIATION
Ronald Crona3f3fca2024-09-02 12:09:18 +0200386#define MBEDTLS_SSL_SERVER_NAME_INDICATION
Ronald Cronf50ae422024-09-09 16:04:23 +0200387#define MBEDTLS_SSL_SESSION_TICKETS
Ronald Cron294b5e02024-09-27 10:04:31 +0200388#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
389#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
390#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
391#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200392//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
393//#define MBEDTLS_USE_PSA_CRYPTO
Ronald Crona25e9db2024-09-03 09:56:46 +0200394#define MBEDTLS_VERSION_C
395#define MBEDTLS_VERSION_FEATURES
Ronald Crona3f3fca2024-09-02 12:09:18 +0200396//#define MBEDTLS_X509_REMOVE_INFO
397#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
Ronald Cron294b5e02024-09-27 10:04:31 +0200398//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
Ronald Crona5a46d02024-09-10 09:40:59 +0200399```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200400
401
Ronald Cron2c152fd2024-09-27 10:30:59 +0200402#### SECTION Mbed TLS modules
Ronald Crona5a46d02024-09-10 09:40:59 +0200403```
Ronald Crona3f3fca2024-09-02 12:09:18 +0200404#define MBEDTLS_DEBUG_C
405#define MBEDTLS_ERROR_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200406#define MBEDTLS_PKCS7_C
407#define MBEDTLS_SSL_CACHE_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200408#define MBEDTLS_SSL_CLI_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200409#define MBEDTLS_SSL_COOKIE_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200410#define MBEDTLS_SSL_SRV_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200411#define MBEDTLS_SSL_TICKET_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200412#define MBEDTLS_SSL_TLS_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200413#define MBEDTLS_X509_CREATE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200414#define MBEDTLS_X509_CRL_PARSE_C
415#define MBEDTLS_X509_CRT_PARSE_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200416#define MBEDTLS_X509_CRT_WRITE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200417#define MBEDTLS_X509_CSR_PARSE_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200418#define MBEDTLS_X509_CSR_WRITE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200419#define MBEDTLS_X509_USE_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200420```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200421
422
Ronald Cron2c152fd2024-09-27 10:30:59 +0200423#### SECTION General configuration options
Ronald Crona5a46d02024-09-10 09:40:59 +0200424```
Ronald Crona3f3fca2024-09-02 12:09:18 +0200425//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
426//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
Ronald Crona5a46d02024-09-10 09:40:59 +0200427```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200428
429
Ronald Cron2c152fd2024-09-27 10:30:59 +0200430#### SECTION Module configuration options
Ronald Crona5a46d02024-09-10 09:40:59 +0200431```
Ronald Cron294b5e02024-09-27 10:04:31 +0200432//#define MBEDTLS_PSK_MAX_LEN 32
Ronald Crona3f3fca2024-09-02 12:09:18 +0200433//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
Ronald Cron294b5e02024-09-27 10:04:31 +0200434//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
Ronald Crona3f3fca2024-09-02 12:09:18 +0200435//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
436//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
437//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Ronald Cron294b5e02024-09-27 10:04:31 +0200438//#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
439//#define MBEDTLS_SSL_COOKIE_TIMEOUT 60
440//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Ronald Cronf50ae422024-09-09 16:04:23 +0200441//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Ronald Crona3f3fca2024-09-02 12:09:18 +0200442//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
Ronald Cronf50ae422024-09-09 16:04:23 +0200443//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Ronald Cron294b5e02024-09-27 10:04:31 +0200444//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
Ronald Crona3f3fca2024-09-02 12:09:18 +0200445//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
446//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Ronald Crona3f3fca2024-09-02 12:09:18 +0200447//#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
Ronald Cron294b5e02024-09-27 10:04:31 +0200448//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
Ronald Crona5a46d02024-09-10 09:40:59 +0200449```