From 13b0bebf7dc3689ef1c210ecf3b770213c444cc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Manuel=20P=C3=A9gouri=C3=A9-Gonnard?= Date: Mon, 20 Sep 2021 13:21:25 +0200 Subject: [PATCH] Add docs/use-psa-crypto.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Manuel Pégourié-Gonnard --- docs/use-psa-crypto.md | 19 +++++++++++++++++++ include/mbedtls/mbedtls_config.h | 3 +++ 2 files changed, 22 insertions(+) create mode 100644 docs/use-psa-crypto.md diff --git a/docs/use-psa-crypto.md b/docs/use-psa-crypto.md new file mode 100644 index 0000000000..a4f43b7832 --- /dev/null +++ b/docs/use-psa-crypto.md @@ -0,0 +1,19 @@ +This document describes the compile-time configutation option +`MBEDTLS_USE_PSA_CRYPTO`: its current effects as well as some design +considerations and plans for the future. + +Current effects +=============== + +(To be written.) + +Parts that are not affected yet +=============================== + +(To be written.) + +Design considerations +===================== + +(To be written.) + diff --git a/include/mbedtls/mbedtls_config.h b/include/mbedtls/mbedtls_config.h index d470c0054b..0680dd98f8 100644 --- a/include/mbedtls/mbedtls_config.h +++ b/include/mbedtls/mbedtls_config.h @@ -1718,6 +1718,9 @@ * will still continue to work as usual, so enabling this option should not * break backwards compatibility. * + * \note See docs/use-psa-crypto.md for a complete description of what this + * option currently does, and of parts that are not affected by it so far. + * * \warning The PSA Crypto API is in beta stage. While you're welcome to * experiment using it, incompatible API changes are still possible, and some * parts may not have reached the same quality as the rest of Mbed TLS yet.