Skip to content

Commit

Permalink
Update configs README
Browse files Browse the repository at this point in the history
This commit updates configs/README.txt and configs/ext/README.md to
reflect the necessary files which were moved to TF-PSA-Crypto.

Signed-off-by: Harry Ramsey <[email protected]>
  • Loading branch information
Harry-Ramsey committed Jan 14, 2025
1 parent 925ed73 commit 03aebfb
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
20 changes: 20 additions & 0 deletions configs/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
This directory contains example configuration files.

The examples are generally focused on a particular usage case (eg, support for
a restricted number of ciphersuites) and aim at minimizing resource usage for
this target. They can be used as a basis for custom configurations.

These files are complete replacements for the default crypto_config.h. To use one of
them, you can pick one of the following methods:

1. Replace the default file include/psa/crypto_config.h with the chosen one.

2. Define TF_PSA_CRYPTO_CONFIG_FILE and adjust the include path accordingly.
For example, using cmake:

find . -iname '*cmake*' -not -name CMakeLists.txt -exec rm -rf {} +
CFLAGS="-I$PWD/configs -DCRYPTO_CONFIG_FILE='<foo.h>'" cmake .
make

Note that the second method also works if you want to keep your custom
configuration file outside the TF-PSA-Crypto tree.
11 changes: 5 additions & 6 deletions configs/ext/README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
Summary
-------

The two files:
The file:

* crypto_config_profile_medium.h
* tfm_mbedcrypto_config_profile_medium.h

are copyright The Mbed TLS Contributors, and are distributed under the license normally
used by Mbed TLS: a dual Apache 2.0 or GPLv2-or-later license.

Background
----------

The two files crypto_config_profile_medium.h and tfm_mbedcrypto_config_profile_medium.h
are taken verbatim from the TF-M source code here:
The file crypto_config_profile_medium.h is taken verbatim from the TF-M source
code here:

https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git/tree/lib/ext/mbedcrypto/mbedcrypto_config

In TF-M, they are distributed under a 3-Clause BSD license, as noted at the top of the files.

In Mbed TLS, with permission from the TF-M project, they are distributed under a dual [Apache-2.0](https://spdx.org/licenses/Apache-2.0.html) OR [GPL-2.0-or-later](https://spdx.org/licenses/GPL-2.0-or-later.html) license, with copyright assigned to The Mbed TLS Contributors.

We only retain the note at the top of the files because we are taking the files verbatim, for ease of
maintenance.
We only retain the note at the top of the files because we are taking the files
verbatim, for ease of maintenance.

0 comments on commit 03aebfb

Please sign in to comment.