blob: 17682ddb8e749930058d389df3f999096e7e4536 [file] [log] [blame]
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +02001This directory contains example configuration files.
2
3The examples are generally focused on a particular usage case (eg, support for
Jaeden Amero1c66e482018-11-02 18:15:18 +00004a restricted number of TLS ciphersuites) and aim at minimizing resource usage
5for this target. They can be used as a basis for custom configurations.
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +02006
7These files are complete replacements for the default config.h. To use one of
8them, you can pick one of the following methods:
9
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +0000101. Replace the default file include/mbedtls/config.h with the chosen one.
Ron Eldorcb8d54b2017-08-23 16:04:40 +030011 (Depending on your compiler, you may need to adjust the line with
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000012 #include "mbedtls/check_config.h" then.)
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +020013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142. Define MBEDTLS_CONFIG_FILE and adjust the include path accordingly.
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +020015 For example, using make:
16
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020017 CFLAGS="-I$PWD/configs -DMBEDTLS_CONFIG_FILE='<foo.h>'" make
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +020018
19 Or, using cmake:
20
Manuel Pégourié-Gonnarde80083c2014-11-14 13:52:32 +010021 find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022 CFLAGS="-I$PWD/configs -DMBEDTLS_CONFIG_FILE='<foo.h>'" cmake .
Manuel Pégourié-Gonnard0bc1f232014-04-30 11:53:50 +020023 make
24
25Note that the second method also works if you want to keep your custom
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +000026configuration file outside the mbed TLS tree.