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 <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2021-05-26 13:10:56 +01:00
parent 702cf09ae9
commit 7d69b3a993

View file

@ -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.
* @{
*/