TeamHepta/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2026-03-20 19:21:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

README.md: Update Configuration section

Browse Source 
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron
2025-09-30 18:30:32 +02:00
parent eef87b348f
commit 0f2ef4a896
2 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -6,12 +6,13 @@ Mbed TLS includes the [TF-PSA-Crypto repository](https://github.com/Mbed-TLS/TF-
Configuration Configuration
------------- -------------
Configuration options related to X.509 and TLS are available in `include/mbedtls/mbedtls_config.h`, while cryptography and platform options are located in the TF-PSA-Crypto configuration file `tf-psa-crypto/include/psa/crypto_config.h`.
Mbed TLS should build out of the box on most systems. Some platform specific options are available in the fully documented configuration file `include/mbedtls/mbedtls_config.h`, which is also the place where features can be selected. This file can be edited manually, or in a more programmatic way using the Python 3 script `scripts/config.py` (use `--help` for usage instructions). With the default platform options, Mbed TLS should build out of the box on most systems.
Compiler options can be set using conventional environment variables such as `CC` and `CFLAGS`. These configuration files can be edited manually, or programmatically using the Python 3 script scripts/config.py (run with --help for usage instructions).
We provide some non-standard configurations focused on specific use cases in the `configs/` directory. You can read more about those in `configs/README.txt` We provide some non-standard configurations focused on specific use cases in the `configs/` directory. You can read more about those in `configs/README.txt`.
Documentation Documentation
------------- -------------

34
configs/README.txt
View File

@@ -1,24 +1,26 @@
This directory contains example configuration files. This directory contains example configuration files.
The examples are generally focused on a particular usage case (eg, support for The examples are generally focused on a particular use case (eg, support for
a restricted number of ciphersuites) and aim at minimizing resource usage for a restricted set of ciphersuites) and aim to minimize resource usage for
this target. They can be used as a basis for custom configurations. the target. They can be used as a basis for custom configurations.
These files are complete replacements for the default mbedtls_config.h. To use one of These files come in pairs and are complete replacements for the default
them, you can pick one of the following methods: mbedtls_config.h and crypto_config.h. The two files of a pair share the same or
very similar name, with the crypto file prefixed by "crypto-". Note
that some of the cryptography configuration files may be located in
tf-psa-crypto/configs.
1. Replace the default file include/mbedtls/mbedtls_config.h with the chosen one. To use one of these pairs, you can pick one of the following methods:
2. Define MBEDTLS_CONFIG_FILE and adjust the include path accordingly. 1. Replace the default files include/mbedtls/mbedtls_config.h and
For example, using make: tf-psa-crypto/include/psa/crypto_config.h with the chosen ones.
CFLAGS="-I$PWD/configs -DMBEDTLS_CONFIG_FILE='<foo.h>'" make 2. Use the MBEDTLS_CONFIG_FILE and TF_PSA_CRYPTO_CONFIG_FILE options of the
CMake build system:
Or, using cmake: cmake -DMBEDTLS_CONFIG_FILE="path-to-your-mbedtls-config-file" \
-DTF_PSA_CRYPTO_CONFIG_FILE="path-to-your-tf-psa-crypto-config-file" .
make
find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} + The second method also works if you want to keep your custom configuration
CFLAGS="-I$PWD/configs -DMBEDTLS_CONFIG_FILE='<foo.h>'" cmake . files outside the Mbed TLS tree.
make
Note that the second method also works if you want to keep your custom
configuration file outside the Mbed TLS tree.