From 7d69b3a993d2785bc75299d8c5dfe7b7c20bf3e4 Mon Sep 17 00:00:00 2001 From: Janos Follath Date: Wed, 26 May 2021 13:10:56 +0100 Subject: [PATCH] PSA PAKE: add warning about stability We are not confident about the stability of the PAKE interface (it is just a proposal, not part of the standard yet). So we should explicitly document it as experimental, subject to change. Signed-off-by: Janos Follath --- include/psa/crypto_extra.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/include/psa/crypto_extra.h b/include/psa/crypto_extra.h index 615b6511c8..4478f3a43c 100644 --- a/include/psa/crypto_extra.h +++ b/include/psa/crypto_extra.h @@ -937,6 +937,14 @@ psa_status_t mbedtls_psa_platform_get_builtin_key( /** @} */ /** \defgroup pake Password-authenticated key exchange (PAKE) + * + * This is a proposed PAKE interface for the PSA Crypto API. It is not part of + * the official PSA Crypto API yet. + * + * \note The content of this section is not part of the stable API and ABI + * of Mbed Crypto and may change arbitrarily from version to version. + * Same holds for the corresponding macros #PSA_ALG_CATEGORY_PAKE and + * #PSA_ALG_JPAKE. * @{ */