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 <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2021-04-08 14:20:55 +01:00
parent b378d57840
commit 7f1e81a98d

View file

@ -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).