blob: 6fd8c4993440eb20ac2501a23e152c6262ef70f7 [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 Cron89d8a272024-09-27 16:08:27 +020034The cryptographic configuration options in `tf_psa_crypto_config.h` are
35organized into sections that are different from the ones in the pre-split
36`mbedtls_config.h` (see below). This is first to take into account the
37specifics of TF-PSA-Crypto, for example a specific section for the
38configuration of builtin drivers. We also get rid of the grouping of non
39boolean options into a dedicated section: related boolean and non boolean
40configuration options are rather grouped together into the same section.
41
42Finally, for consistency, the sections in `mbedtls_config.h` are reorganized
43to be better aligned with the `tf_psa_crypto_config.h` ones.
44
Ronald Cron5e292602024-09-03 16:01:48 +020045
Ronald Cron075c7422024-09-09 15:43:38 +020046## Configuration files and `config.py`
Ronald Cron5e292602024-09-03 16:01:48 +020047
Ronald Cron075c7422024-09-09 15:43:38 +020048Each repository contains a `config.py` script to create and modify
49configurations.
Ronald Cron5e292602024-09-03 16:01:48 +020050
Ronald Cron075c7422024-09-09 15:43:38 +020051In Mbed TLS, `config.py` handles both `mbedtls_config.h` and
52`tf_psa_crypto_config.h`. It can set or unset TLS, x509 and cryptographic
Ronald Cron5e292602024-09-03 16:01:48 +020053configuration options without having to specify the configuration file the
54options belong to. Commands like full and baremetal affect both configuration
55files.
56
Ronald Cron075c7422024-09-09 15:43:38 +020057In TF-PSA-Crypto, `config.py` addresses only `tf_psa_crypto_config.h`.
Ronald Cron8793d9c2024-06-06 17:54:45 +020058
Ronald Cron075c7422024-09-09 15:43:38 +020059## Sections in `tf_psa_crypto_config.h`
Ronald Cron8793d9c2024-06-06 17:54:45 +020060
Ronald Cron075c7422024-09-09 15:43:38 +020061The `tf_psa_crypto_config.h` configuration file is organized into eight
62sections.
Ronald Cron8793d9c2024-06-06 17:54:45 +020063
Ronald Cron075c7422024-09-09 15:43:38 +020064The pre-split `mbedtls_config.h` configuration file contains configuration
Ronald Cron8793d9c2024-06-06 17:54:45 +020065options that apply to the whole code base (TLS, x509, crypto and tests) mostly
Ronald Cron075c7422024-09-09 15:43:38 +020066related to the platform abstraction layer and testing. In
67`tf_psa_crypto_config.h` these configurations options are organized into two
68sections, one for the platform abstraction layer options and one for the others,
Ronald Cron2c152fd2024-09-27 10:30:59 +020069respectively named ["Platform abstraction layer"](#section-platform-abstraction-layer)
70and ["General and test configuration options"](#section-general-and-test-configuration-options).
Ronald Cron8793d9c2024-06-06 17:54:45 +020071
Ronald Cron2c152fd2024-09-27 10:30:59 +020072Then, the ["Cryptographic mechanism selection (PSA API)"](#section-cryptographic-mechanism-selection-PSA-API)
73section is the equivalent of the pre-split `crypto_config.h` configuration file
74containing the PSA_WANT_ prefixed macros.
Ronald Cron8793d9c2024-06-06 17:54:45 +020075
Ronald Cron2c152fd2024-09-27 10:30:59 +020076The following section named
77["Cryptographic mechanism selection (extended API)"](#section-cryptographic-mechanism-selection-extended-API)
Ronald Cron8e1b4632024-09-02 16:21:44 +020078contains the configuration options for the cryptography mechanisms that are not
79yet part of the PSA cryptography API (like LMS or PK).
80
Ronald Cron2c152fd2024-09-27 10:30:59 +020081It is followed by the ["Data format support"](#section-data-format-support)
82section that contains configuration options of utilities related to various data
83formats (like Base64 or ASN.1 APIs). These utilities aim to facilitate the
84usage of the PSA cryptography API in other cryptography projects.
Ronald Cron8e1b4632024-09-02 16:21:44 +020085
Ronald Cron8793d9c2024-06-06 17:54:45 +020086Compared to Mbed TLS, the cryptography code in TF-PSA-Crypto is not located
87in a single directory but split between the PSA core (core directory) and the
88PSA builtin drivers (drivers/builtin/src directory). This is reflected in
Ronald Cron2c152fd2024-09-27 10:30:59 +020089`tf_psa_crypto_config.h` with two sections respectively named ["PSA core"](#section-psa-core)
90and ["Builtin drivers"](#section-builtin-drivers).
Ronald Cron8793d9c2024-06-06 17:54:45 +020091
Ronald Cron2c152fd2024-09-27 10:30:59 +020092Finally, the last section named ["Legacy cryptography"](#section-legacy-cryptography)
93contains the configuration options that will eventually be removed as duplicates
94of PSA_WANT_\* and MBEDTLS_PSA_ACCEL_\* configuration options.
Ronald Cronad62dce2024-09-02 14:22:24 +020095
Ronald Cronbe352632024-09-27 10:55:25 +020096## Sections in `mbedtls_config.h`
97
98The sections in `mbedtls_config.h` are reorganized to be better aligned with
99the ones in `tf_psa_crypto_config.h`. The main change is the reorganization
Ronald Cron5f646112024-10-02 13:58:26 +0200100of the "Mbed TLS modules", "Mbed TLS feature support" and
101"Module configuration options" sections into the
102["TLS feature selection"](#section-tls-feature-selection) and
Ronald Croncbafe752024-10-03 09:33:25 +0200103["X.509 feature selection"](#section-x-509-feature-selection) sections. That
Ronald Cron5f646112024-10-02 13:58:26 +0200104way all TLS/x509 options are grouped into one section and there is no
105section dedicated to non boolean configuration options anymore.
Ronald Cronbe352632024-09-27 10:55:25 +0200106
Ronald Cron8793d9c2024-06-06 17:54:45 +0200107
Ronald Cron8793d9c2024-06-06 17:54:45 +0200108## Repartition of the configuration options
109
Ronald Cron075c7422024-09-09 15:43:38 +0200110### In `tf_psa_crypto_config.h`, we have:
Ronald Cron2c152fd2024-09-27 10:30:59 +0200111#### SECTION Platform abstraction layer
Ronald Crona5a46d02024-09-10 09:40:59 +0200112```
Ronald Cronf50ae422024-09-09 16:04:23 +0200113#define MBEDTLS_FS_IO
Ronald Crona3f3fca2024-09-02 12:09:18 +0200114#define MBEDTLS_HAVE_TIME
115#define MBEDTLS_HAVE_TIME_DATE
Ronald Crona3f3fca2024-09-02 12:09:18 +0200116//#define MBEDTLS_MEMORY_BACKTRACE
Minos Galanakiscb32d082024-11-29 17:53:24 +0000117//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200118//#define MBEDTLS_MEMORY_DEBUG
Ronald Cronf50ae422024-09-09 16:04:23 +0200119#define MBEDTLS_PLATFORM_C
120//#define MBEDTLS_PLATFORM_EXIT_ALT
121//#define MBEDTLS_PLATFORM_FPRINTF_ALT
122//#define MBEDTLS_PLATFORM_GMTIME_R_ALT
123//#define MBEDTLS_PLATFORM_MEMORY
124//#define MBEDTLS_PLATFORM_MS_TIME_ALT
125//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS
126//#define MBEDTLS_PLATFORM_NV_SEED_ALT
127//#define MBEDTLS_PLATFORM_PRINTF_ALT
128//#define MBEDTLS_PLATFORM_SETBUF_ALT
129//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT
130//#define MBEDTLS_PLATFORM_SNPRINTF_ALT
131//#define MBEDTLS_PLATFORM_TIME_ALT
132//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT
133//#define MBEDTLS_PLATFORM_ZEROIZE_ALT
Ronald Cron4f4a30c2024-09-02 15:00:54 +0200134//#define MBEDTLS_THREADING_ALT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200135//#define MBEDTLS_THREADING_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200136//#define MBEDTLS_THREADING_PTHREAD
Ronald Cronf50ae422024-09-09 16:04:23 +0200137
138//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4
Ronald Crona3f3fca2024-09-02 12:09:18 +0200139//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc
Ronald Crona3f3fca2024-09-02 12:09:18 +0200140//#define MBEDTLS_PLATFORM_EXIT_MACRO exit
Ronald Cronf50ae422024-09-09 16:04:23 +0200141//#define MBEDTLS_PLATFORM_FREE_MACRO free
Ronald Crona3f3fca2024-09-02 12:09:18 +0200142//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf
Ronald Crona3f3fca2024-09-02 12:09:18 +0200143//#define MBEDTLS_PLATFORM_MS_TIME_TYPE_MACRO int64_t
Ronald Cronf50ae422024-09-09 16:04:23 +0200144//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read
145//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write
146//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf
147//#define MBEDTLS_PLATFORM_SETBUF_MACRO setbuf
Ronald Cron294b5e02024-09-27 10:04:31 +0200148//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf
Ronald Cronf50ae422024-09-09 16:04:23 +0200149//#define MBEDTLS_PLATFORM_STD_CALLOC calloc
150//#define MBEDTLS_PLATFORM_STD_EXIT exit
151//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1
152//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0
153//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf
154//#define MBEDTLS_PLATFORM_STD_FREE free
155//#define MBEDTLS_PLATFORM_STD_MEM_HDR <stdlib.h>
156//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile"
157//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read
158//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write
159//#define MBEDTLS_PLATFORM_STD_PRINTF printf
160//#define MBEDTLS_PLATFORM_STD_SETBUF setbuf
161//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf
162//#define MBEDTLS_PLATFORM_STD_TIME time
Ronald Cronf50ae422024-09-09 16:04:23 +0200163//#define MBEDTLS_PLATFORM_TIME_MACRO time
164//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t
165//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf
Ronald Cron294b5e02024-09-27 10:04:31 +0200166//#define MBEDTLS_PRINTF_MS_TIME PRId64
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 General and test configuration options
Ronald Croneb589f92024-09-27 16:10:20 +0200170Note: for consistency with the configuration file name change from
171`crypto_config.h` to `tf_psa_crypto_config.h`, the configuration options
Ronald Cron3ca3f152024-10-03 09:29:36 +0200172`MBEDTLS_PSA_CRYPTO_CONFIG_FILE` and `MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE` are
173respectively renamed `TF_PSA_CRYPTO_CONFIG_FILE` and
174`TF_PSA_CRYPTO_USER_CONFIG_FILE`. These are the only configuration options
175renamed by this document.
Ronald Crona5a46d02024-09-10 09:40:59 +0200176```
Ronald Cronf50ae422024-09-09 16:04:23 +0200177//#define MBEDTLS_CHECK_RETURN_WARNING
178//#define MBEDTLS_DEPRECATED_REMOVED
179//#define MBEDTLS_DEPRECATED_WARNING
Ronald Cron717663b2024-09-02 15:30:10 +0200180#define MBEDTLS_SELF_TEST
Ronald Crona3f3fca2024-09-02 12:09:18 +0200181//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN
182//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND
183//#define MBEDTLS_TEST_HOOKS
Ronald Cron8793d9c2024-06-06 17:54:45 +0200184
Ronald Crone5d0f8c2024-09-02 15:43:10 +0200185//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__))
186//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result))
Ronald Croneb589f92024-09-27 16:10:20 +0200187//#define TF_PSA_CRYPTO_CONFIG_FILE "psa/tf_psa_crypto_config.h"
188//#define TF_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null"
Ronald Crona5a46d02024-09-10 09:40:59 +0200189```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200190
Ronald Cron2c152fd2024-09-27 10:30:59 +0200191#### SECTION Cryptographic mechanism selection (PSA API)
Ronald Cron075c7422024-09-09 15:43:38 +0200192PSA_WANT_\* macros as in current `crypto_config.h`.
Ronald Cron8793d9c2024-06-06 17:54:45 +0200193
194
Ronald Cron2c152fd2024-09-27 10:30:59 +0200195#### SECTION Cryptographic mechanism selection (extended API)
Ronald Crona5a46d02024-09-10 09:40:59 +0200196```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200197#define MBEDTLS_LMS_C
198//#define MBEDTLS_LMS_PRIVATE
199#define MBEDTLS_MD_C
200#define MBEDTLS_NIST_KW_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200201#define MBEDTLS_PKCS5_C
202#define MBEDTLS_PKCS12_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200203#define MBEDTLS_PK_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200204#define MBEDTLS_PK_PARSE_C
Ronald Cron8e1b4632024-09-02 16:21:44 +0200205#define MBEDTLS_PK_PARSE_EC_COMPRESSED
Ronald Cron294b5e02024-09-27 10:04:31 +0200206#define MBEDTLS_PK_PARSE_EC_EXTENDED
Ronald Cron8e1b4632024-09-02 16:21:44 +0200207#define MBEDTLS_PK_RSA_ALT_SUPPORT
Ronald Cron8e1b4632024-09-02 16:21:44 +0200208#define MBEDTLS_PK_WRITE_C
Ronald Cron8e1b4632024-09-02 16:21:44 +0200209
Ronald Cron8e1b4632024-09-02 16:21:44 +0200210//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48
Ronald Cron8e1b4632024-09-02 16:21:44 +0200211//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256
212//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024
213//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384
Ronald Cronf50ae422024-09-09 16:04:23 +0200214//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000
Ronald Cron8e1b4632024-09-02 16:21:44 +0200215//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256
216//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024
217//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384
Ronald Cronf50ae422024-09-09 16:04:23 +0200218//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000
219//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256
Ronald Crona5a46d02024-09-10 09:40:59 +0200220```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200221
222
Ronald Cron2c152fd2024-09-27 10:30:59 +0200223#### SECTION Data format support
Ronald Crona5a46d02024-09-10 09:40:59 +0200224```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200225#define MBEDTLS_ASN1_PARSE_C
226#define MBEDTLS_ASN1_WRITE_C
227#define MBEDTLS_BASE64_C
228#define MBEDTLS_OID_C
229#define MBEDTLS_PEM_PARSE_C
230#define MBEDTLS_PEM_WRITE_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200231```
Ronald Cron8e1b4632024-09-02 16:21:44 +0200232
233
Ronald Cron2c152fd2024-09-27 10:30:59 +0200234#### SECTION PSA core
Ronald Crona5a46d02024-09-10 09:40:59 +0200235```
Ronald Cronf50ae422024-09-09 16:04:23 +0200236#define MBEDTLS_ENTROPY_C
237//#define MBEDTLS_ENTROPY_FORCE_SHA256
Ronald Crona3f3fca2024-09-02 12:09:18 +0200238//#define MBEDTLS_ENTROPY_HARDWARE_ALT
Ronald Cronf50ae422024-09-09 16:04:23 +0200239//#define MBEDTLS_ENTROPY_NV_SEED
Ronald Crona3f3fca2024-09-02 12:09:18 +0200240//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES
241//#define MBEDTLS_NO_PLATFORM_ENTROPY
Ronald Cronf50ae422024-09-09 16:04:23 +0200242//#define MBEDTLS_PSA_ASSUME_EXCLUSIVE_BUFFERS
243//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS
Ronald Cron294b5e02024-09-27 10:04:31 +0200244#define MBEDTLS_PSA_CRYPTO_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200245//#define MBEDTLS_PSA_CRYPTO_CLIENT
246//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG
Ronald Cronf50ae422024-09-09 16:04:23 +0200247//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200248//#define MBEDTLS_PSA_CRYPTO_SPM
Ronald Crona3f3fca2024-09-02 12:09:18 +0200249#define MBEDTLS_PSA_CRYPTO_STORAGE_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200250//#define MBEDTLS_PSA_INJECT_ENTROPY
Ronald Crona3f3fca2024-09-02 12:09:18 +0200251#define MBEDTLS_PSA_ITS_FILE_C
Minos Galanakiscb32d082024-11-29 17:53:24 +0000252#define MBEDTLS_PSA_KEY_STORE_DYNAMIC
253//#define MBEDTLS_PSA_STATIC_KEY_SLOTS
Ronald Cronf50ae422024-09-09 16:04:23 +0200254
Ronald Crona3f3fca2024-09-02 12:09:18 +0200255//#define MBEDTLS_ENTROPY_MAX_GATHER 128
Ronald Cron294b5e02024-09-27 10:04:31 +0200256//#define MBEDTLS_ENTROPY_MAX_SOURCES 20
Ronald Crona3f3fca2024-09-02 12:09:18 +0200257//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32
Ronald Cronf50ae422024-09-09 16:04:23 +0200258//#define MBEDTLS_PSA_CRYPTO_PLATFORM_FILE "psa/crypto_platform_alt.h"
259//#define MBEDTLS_PSA_CRYPTO_STRUCT_FILE "psa/crypto_struct_alt.h"
260//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32
Minos Galanakiscb32d082024-11-29 17:53:24 +0000261//#define MBEDTLS_PSA_STATIC_KEY_SLOT_BUFFER_SIZE 256
Ronald Crona5a46d02024-09-10 09:40:59 +0200262```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200263
Ronald Cron2c152fd2024-09-27 10:30:59 +0200264#### SECTION Builtin drivers
Ronald Crona5a46d02024-09-10 09:40:59 +0200265```
Ronald Crona3f3fca2024-09-02 12:09:18 +0200266#define MBEDTLS_AESCE_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200267#define MBEDTLS_AESNI_C
Ronald Crona3f3fca2024-09-02 12:09:18 +0200268//#define MBEDTLS_AES_FEWER_TABLES
269//#define MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH
Ronald Cron294b5e02024-09-27 10:04:31 +0200270//#define MBEDTLS_AES_ROM_TABLES
Ronald Crona3f3fca2024-09-02 12:09:18 +0200271//#define MBEDTLS_AES_USE_HARDWARE_ONLY
Ronald Cronf50ae422024-09-09 16:04:23 +0200272//#define MBEDTLS_BLOCK_CIPHER_NO_DECRYPT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200273//#define MBEDTLS_CAMELLIA_SMALL_MEMORY
274//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED
275#define MBEDTLS_ECP_NIST_OPTIM
Ronald Cron4f4a30c2024-09-02 15:00:54 +0200276//#define MBEDTLS_ECP_RESTARTABLE
Ronald Crona3f3fca2024-09-02 12:09:18 +0200277//#define MBEDTLS_ECP_WITH_MPI_UINT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200278//#define MBEDTLS_GCM_LARGE_TABLE
Ronald Cronf50ae422024-09-09 16:04:23 +0200279#define MBEDTLS_HAVE_ASM
280//#define MBEDTLS_HAVE_SSE2
281//#define MBEDTLS_NO_UDBL_DIVISION
282//#define MBEDTLS_NO_64BIT_MULTIPLICATION
283//#define MBEDTLS_PSA_P256M_DRIVER_ENABLED
284//#define MBEDTLS_RSA_NO_CRT
285//#define MBEDTLS_SHA256_SMALLER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200286//#define MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT
Ronald Crona3f3fca2024-09-02 12:09:18 +0200287//#define MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY
Ronald Cron294b5e02024-09-27 10:04:31 +0200288//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_IF_PRESENT
289//#define MBEDTLS_SHA256_USE_ARMV8_A_CRYPTO_ONLY
Ronald Cronf50ae422024-09-09 16:04:23 +0200290//#define MBEDTLS_SHA512_SMALLER
Ronald Crona3f3fca2024-09-02 12:09:18 +0200291//#define MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT
292//#define MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY
Ronald Crone2b24d32024-10-01 13:00:02 +0200293//#define MBEDTLS_USE_PSA_CRYPTO
Ronald Cronf50ae422024-09-09 16:04:23 +0200294
Ronald Crona3f3fca2024-09-02 12:09:18 +0200295//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1
Ronald Cronf50ae422024-09-09 16:04:23 +0200296//#define MBEDTLS_ECP_WINDOW_SIZE 4
297//#define MBEDTLS_MPI_MAX_SIZE 1024
298//#define MBEDTLS_MPI_WINDOW_SIZE 2
Ronald Crona3f3fca2024-09-02 12:09:18 +0200299//#define MBEDTLS_RSA_GEN_KEY_MIN_BITS 1024
Ronald Crona5a46d02024-09-10 09:40:59 +0200300```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200301
302
Ronald Cron2c152fd2024-09-27 10:30:59 +0200303#### SECTION Legacy cryptography
Ronald Crona5a46d02024-09-10 09:40:59 +0200304```
Ronald Cronf50ae422024-09-09 16:04:23 +0200305#define MBEDTLS_AES_C
306#define MBEDTLS_ARIA_C
307#define MBEDTLS_BIGNUM_C
308#define MBEDTLS_CAMELLIA_C
309#define MBEDTLS_CCM_C
310#define MBEDTLS_CHACHA20_C
311#define MBEDTLS_CHACHAPOLY_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200312#define MBEDTLS_CIPHER_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200313#define MBEDTLS_CIPHER_MODE_CBC
314#define MBEDTLS_CIPHER_MODE_CFB
315#define MBEDTLS_CIPHER_MODE_CTR
316#define MBEDTLS_CIPHER_MODE_OFB
317#define MBEDTLS_CIPHER_MODE_XTS
Minos Galanakisf33250f2024-12-02 16:01:20 +0000318//#define MBEDTLS_CIPHER_NULL_CIPHER
Ronald Cronad62dce2024-09-02 14:22:24 +0200319#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS
Ronald Cron294b5e02024-09-27 10:04:31 +0200320#define MBEDTLS_CIPHER_PADDING_PKCS7
Ronald Cronad62dce2024-09-02 14:22:24 +0200321#define MBEDTLS_CIPHER_PADDING_ZEROS
Ronald Cron294b5e02024-09-27 10:04:31 +0200322#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN
Ronald Cronf50ae422024-09-09 16:04:23 +0200323#define MBEDTLS_CMAC_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200324#define MBEDTLS_CTR_DRBG_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200325//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY
326#define MBEDTLS_DES_C
327#define MBEDTLS_DHM_C
328#define MBEDTLS_ECDH_C
329#define MBEDTLS_ECP_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200330#define MBEDTLS_ECP_DP_BP256R1_ENABLED
331#define MBEDTLS_ECP_DP_BP384R1_ENABLED
332#define MBEDTLS_ECP_DP_BP512R1_ENABLED
333#define MBEDTLS_ECP_DP_CURVE25519_ENABLED
334#define MBEDTLS_ECP_DP_CURVE448_ENABLED
Ronald Cron294b5e02024-09-27 10:04:31 +0200335#define MBEDTLS_ECP_DP_SECP192K1_ENABLED
336#define MBEDTLS_ECP_DP_SECP192R1_ENABLED
337#define MBEDTLS_ECP_DP_SECP224K1_ENABLED
338#define MBEDTLS_ECP_DP_SECP224R1_ENABLED
339#define MBEDTLS_ECP_DP_SECP256K1_ENABLED
340#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
341#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
342#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
Ronald Cronad62dce2024-09-02 14:22:24 +0200343#define MBEDTLS_ECDSA_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200344#define MBEDTLS_ECDSA_DETERMINISTIC
Ronald Cronad62dce2024-09-02 14:22:24 +0200345#define MBEDTLS_ECJPAKE_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200346#define MBEDTLS_GCM_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200347#define MBEDTLS_GENPRIME
Ronald Cronad62dce2024-09-02 14:22:24 +0200348#define MBEDTLS_HKDF_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200349#define MBEDTLS_HMAC_DRBG_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200350#define MBEDTLS_MD5_C
351#define MBEDTLS_PADLOCK_C
Ronald Cronf50ae422024-09-09 16:04:23 +0200352#define MBEDTLS_PKCS1_V15
353#define MBEDTLS_PKCS1_V21
Ronald Cronad62dce2024-09-02 14:22:24 +0200354#define MBEDTLS_POLY1305_C
355//#define MBEDTLS_PSA_CRYPTO_SE_C
356#define MBEDTLS_RIPEMD160_C
357#define MBEDTLS_RSA_C
358#define MBEDTLS_SHA1_C
359#define MBEDTLS_SHA224_C
360#define MBEDTLS_SHA256_C
361#define MBEDTLS_SHA384_C
Ronald Cronad62dce2024-09-02 14:22:24 +0200362#define MBEDTLS_SHA3_C
Ronald Cron294b5e02024-09-27 10:04:31 +0200363#define MBEDTLS_SHA512_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200364```
Ronald Cronad62dce2024-09-02 14:22:24 +0200365
Ronald Cron8793d9c2024-06-06 17:54:45 +0200366
Ronald Cron075c7422024-09-09 15:43:38 +0200367### In `mbedtls_config.h`, we have:
Ronald Cron2c152fd2024-09-27 10:30:59 +0200368#### SECTION Platform abstraction layer
Ronald Crona5a46d02024-09-10 09:40:59 +0200369```
Ronald Cron34a40862024-09-02 15:33:45 +0200370#define MBEDTLS_NET_C
Ronald Cron2589ee32024-09-09 16:22:56 +0200371//#define MBEDTLS_TIMING_ALT
Ronald Cron294b5e02024-09-27 10:04:31 +0200372#define MBEDTLS_TIMING_C
Ronald Crona5a46d02024-09-10 09:40:59 +0200373```
Ronald Cron8793d9c2024-06-06 17:54:45 +0200374
Ronald Cronbe352632024-09-27 10:55:25 +0200375
Ronald Cronb992bc82024-09-27 10:45:13 +0200376#### SECTION General configuration options
377```
Ronald Cronda4522c2024-10-01 12:56:43 +0200378#define MBEDTLS_ERROR_C
Ronald Cron5f646112024-10-02 13:58:26 +0200379#define MBEDTLS_ERROR_STRERROR_DUMMY
380#define MBEDTLS_VERSION_C
381#define MBEDTLS_VERSION_FEATURES
382
Ronald Cronb992bc82024-09-27 10:45:13 +0200383//#define MBEDTLS_CONFIG_FILE "mbedtls/mbedtls_config.h"
384//#define MBEDTLS_USER_CONFIG_FILE "/dev/null"
385```
386
Ronald Cronbe352632024-09-27 10:55:25 +0200387
388#### SECTION TLS feature selection
Ronald Cronb992bc82024-09-27 10:45:13 +0200389```
390#define MBEDTLS_DEBUG_C
Ronald Cron5f646112024-10-02 13:58:26 +0200391#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED
392#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED
393#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED
394#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED
395#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED
396#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED
397#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED
398//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED
399#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED
400#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED
401#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED
402#define MBEDTLS_SSL_ALL_ALERT_MESSAGES
403#define MBEDTLS_SSL_ALPN
404//#define MBEDTLS_SSL_ASYNC_PRIVATE
Ronald Cronb992bc82024-09-27 10:45:13 +0200405#define MBEDTLS_SSL_CACHE_C
406#define MBEDTLS_SSL_CLI_C
Ronald Cron5f646112024-10-02 13:58:26 +0200407#define MBEDTLS_SSL_CONTEXT_SERIALIZATION
Ronald Cronb992bc82024-09-27 10:45:13 +0200408#define MBEDTLS_SSL_COOKIE_C
Ronald Cron5f646112024-10-02 13:58:26 +0200409//#define MBEDTLS_SSL_DEBUG_ALL
410#define MBEDTLS_SSL_DTLS_ANTI_REPLAY
411#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE
412#define MBEDTLS_SSL_DTLS_CONNECTION_ID
413#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
414#define MBEDTLS_SSL_DTLS_HELLO_VERIFY
415//#define MBEDTLS_SSL_DTLS_SRTP
416//#define MBEDTLS_SSL_EARLY_DATA
417#define MBEDTLS_SSL_ENCRYPT_THEN_MAC
418#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET
419#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE
420#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH
421#define MBEDTLS_SSL_PROTO_DTLS
422#define MBEDTLS_SSL_PROTO_TLS1_2
423#define MBEDTLS_SSL_PROTO_TLS1_3
424//#define MBEDTLS_SSL_RECORD_SIZE_LIMIT
425#define MBEDTLS_SSL_RENEGOTIATION
426#define MBEDTLS_SSL_SERVER_NAME_INDICATION
427#define MBEDTLS_SSL_SESSION_TICKETS
Ronald Cronb992bc82024-09-27 10:45:13 +0200428#define MBEDTLS_SSL_SRV_C
429#define MBEDTLS_SSL_TICKET_C
Ronald Cron5f646112024-10-02 13:58:26 +0200430#define MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE
431#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED
432#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED
433#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED
Ronald Cronb992bc82024-09-27 10:45:13 +0200434#define MBEDTLS_SSL_TLS_C
Ronald Cron5f646112024-10-02 13:58:26 +0200435//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH
Ronald Cronb992bc82024-09-27 10:45:13 +0200436
Ronald Cronb992bc82024-09-27 10:45:13 +0200437//#define MBEDTLS_PSK_MAX_LEN 32
438//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50
439//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400
440//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
441//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
442//#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
443//#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
444//#define MBEDTLS_SSL_COOKIE_TIMEOUT 60
445//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
446//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
447//#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
448//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
449//#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
450//#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
451//#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
Ronald Cronbe352632024-09-27 10:55:25 +0200452```
453
454
455#### SECTION X.509 feature selection
456```
457#define MBEDTLS_PKCS7_C
458#define MBEDTLS_X509_CREATE_C
459#define MBEDTLS_X509_CRL_PARSE_C
460#define MBEDTLS_X509_CRT_PARSE_C
461#define MBEDTLS_X509_CRT_WRITE_C
462#define MBEDTLS_X509_CSR_PARSE_C
463#define MBEDTLS_X509_CSR_WRITE_C
Ronald Cron5f646112024-10-02 13:58:26 +0200464//#define MBEDTLS_X509_REMOVE_INFO
465#define MBEDTLS_X509_RSASSA_PSS_SUPPORT
466//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK
Ronald Cronbe352632024-09-27 10:55:25 +0200467#define MBEDTLS_X509_USE_C
468
Ronald Cronb992bc82024-09-27 10:45:13 +0200469//#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512
470//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8
471```