mirror of
https://github.com/Mbed-TLS/mbedtls.git
synced 2025-03-29 04:20:12 +00:00
PSA PAKE: fix documentation
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
parent
ef816f37be
commit
14ce06afe2
@ -4139,7 +4139,7 @@ static void psa_pake_cs_set_algorithm(
|
||||
psa_algorithm_t algorithm
|
||||
);
|
||||
|
||||
/** Retrieve the primitive type from a PAKE cipher suite.
|
||||
/** Retrieve the primitive from a PAKE cipher suite.
|
||||
*
|
||||
* This function may be declared as `static` (i.e. without external linkage).
|
||||
* This function may be provided as a function-like macro, but in this case it
|
||||
@ -4153,7 +4153,7 @@ static psa_pake_primitive_t psa_pake_cs_get_primitive(
|
||||
const psa_pake_cipher_suite_t* cipher_suite
|
||||
);
|
||||
|
||||
/** Declare the primitive type for a PAKE cipher suite.
|
||||
/** Declare the primitive for a PAKE cipher suite.
|
||||
*
|
||||
* This function overwrites any primitive previously set in \p cipher_suite.
|
||||
*
|
||||
@ -4353,7 +4353,7 @@ psa_status_t psa_pake_setup(psa_pake_operation_t *operation,
|
||||
psa_status_t psa_pake_set_password_key(psa_pake_operation_t *operation,
|
||||
mbedtls_svc_key_id_t password);
|
||||
|
||||
/** Set the password for a password-authenticated key exchange with memory hard
|
||||
/** Set the password for a password-authenticated key exchange via a memory hard
|
||||
* function.
|
||||
*
|
||||
* Some protocols require using values derived from passwords via memory hard
|
||||
|
@ -1988,7 +1988,7 @@
|
||||
* J-PAKE doesn't differentiate between sides and has a distinct identifier
|
||||
* associated with each entity. This means that both psa_pake_set_user() and
|
||||
* psa_pake_set_peer() needs to be called before commencing the operation.
|
||||
* Another conseque is that psa_pake_set_side() is optional and is ignored.
|
||||
* Another consequence is that psa_pake_set_side() is optional and is ignored.
|
||||
*
|
||||
* The key exchange flow for JPAKE is as follows:
|
||||
* -# To get the first round data that needs to be sent to the peer, call
|
||||
|
Loading…
x
Reference in New Issue
Block a user