blob: 6f433c5f7f6e192193f9b03ca9fccc2dd62baed4 [file] [log] [blame] [view]
Bence Szépkúti90b79ab2021-06-04 00:19:53 +02001Introduce a level of indirection and versioning in the config files
2-------------------------------------------------------------------
3
4`config.h` was split into `build_info.h` and `mbedtls_config.h`.
Bence Szépkútidbf5d2b2021-06-28 10:34:29 +01005
6* In code, use `#include <mbedtls/build_info.h>`. Don't include `mbedtls/config.h` and don't refer to `MBEDTLS_CONFIG_FILE`.
7* In build tools, edit `mbedtls_config.h`, or edit `MBEDTLS_CONFIG_FILE` as before.
8* If you had a tool that parsed the library version from `include/mbedtls/version.h`, this has moved to `include/mbedtls/build_info.h`. From C code, both headers now define the `MBEDTLS_VERSION_xxx` macros.
9
10Also, if you have a custom configuration file:
11
Bence Szépkúti9cd70652021-06-28 14:22:39 +010012* Don't include `check_config.h` or `config_psa.h` anymore.
Bence Szépkútidbf5d2b2021-06-28 10:34:29 +010013* Don't define `MBEDTLS_CONFIG_H` anymore.
Bence Szépkúti90b79ab2021-06-04 00:19:53 +020014
Bence Szépkúti60c86342021-06-22 10:03:02 +020015A config file version symbol, `MBEDTLS_CONFIG_VERSION` was introduced.
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010016Defining it to a particular value will ensure that Mbed TLS interprets
Bence Szépkúti36da4cc2021-06-21 17:14:41 +020017the config file in a way that's compatible with the config file format
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010018used by the Mbed TLS release whose `MBEDTLS_VERSION_NUMBER` has the same
Bence Szépkúti60c86342021-06-22 10:03:02 +020019value.
Bence Szépkúti1b2a8832021-06-28 10:26:11 +010020The only value supported by Mbed TLS 3.0.0 is `0x03000000`.