lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-29 11:41:15 +03:00
Code Activity

Improve psa_pake_set_peer()/user() documentation

Browse Source 
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath
2021-05-25 15:46:56 +01:00
parent 56a4d7a59f
commit 7c59b7a073
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
include/psa/crypto.h
View File

@ -4422,9 +4422,10 @@ psa_status_t psa_pake_set_password_stretch(
/** Set the user ID for a password-authenticated key exchange. /** Set the user ID for a password-authenticated key exchange.
* *
* Some PAKE algorithms associate only a single user identifier with the * Call this function to set the user ID. For PAKE algorithms that associate a
* session. Such algorithms must call this function (psa_pake_set_user()) to * user identifier with each side of the session you need to call
* set the identifier for the PAKE context. * psa_pake_set_peer() as well. For PAKE algorithms that associate a single
* user identifier with the session, call psa_pake_set_user() only.
* *
* Refer to the documentation of individual PAKE algorithm types (`PSA_ALG_XXX` * Refer to the documentation of individual PAKE algorithm types (`PSA_ALG_XXX`
* values of type ::psa_algorithm_t such that #PSA_ALG_IS_PAKE(\c alg) is true) * values of type ::psa_algorithm_t such that #PSA_ALG_IS_PAKE(\c alg) is true)
@ -4461,9 +4462,10 @@ psa_status_t psa_pake_set_user(psa_pake_operation_t *operation,
/** Set the peer ID for a password-authenticated key exchange. /** Set the peer ID for a password-authenticated key exchange.
* *
* Some PAKE algorithms associate only a single user identifier with the * Call this function in addition to psa_pake_set_user() for PAKE algorithms
* session. Such algorithms must call psa_pake_set_user() to set the * that associate a user identifier with each side of the session. For PAKE
* identifier for the PAKE context. * algorithms that associate a single user identifier with the session, call
* psa_pake_set_user() only.
* *
* Refer to the documentation of individual PAKE algorithm types (`PSA_ALG_XXX` * Refer to the documentation of individual PAKE algorithm types (`PSA_ALG_XXX`
* values of type ::psa_algorithm_t such that #PSA_ALG_IS_PAKE(\c alg) is true) * values of type ::psa_algorithm_t such that #PSA_ALG_IS_PAKE(\c alg) is true)