From 7f1e81a98dd783edf1d572883d11e2de5ffd9bce Mon Sep 17 00:00:00 2001 From: Janos Follath Date: Thu, 8 Apr 2021 14:20:55 +0100 Subject: [PATCH] PSA PAKE: specify key type and usage The PSA_KEY_TYPE_PASSWORD key type to which this documentation change refers to is not yet present in the code and will be introduced by a parallel line of work. Signed-off-by: Janos Follath --- include/psa/crypto.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/include/psa/crypto.h b/include/psa/crypto.h index 88cc2d149d..79d997672e 100644 --- a/include/psa/crypto.h +++ b/include/psa/crypto.h @@ -4266,8 +4266,10 @@ static psa_pake_operation_t psa_pake_operation_init(void); * \param password Identifier of the key holding the password or a * value derived from the password (eg. by a * memory-hard function). It must remain valid - * until the operation terminates. It must allow - * the usage #PSA_KEY_USAGE_PAKE. + * until the operation terminates. It must be of + * type #PSA_KEY_TYPE_PASSWORD or + * #PSA_KEY_TYPE_DERIVE. It has to allow the usage + * #PSA_KEY_USAGE_DERIVE. * \param alg The PAKE protocol to use * (\c PSA_ALG_XXX value such that * #PSA_ALG_IS_PAKE(\p alg) is true).