yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

PSA PAKE: fix doxygen warnings

Browse source 
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2021-04-12 10:00:43 +01:00
parent 7f1e81a98d
commit ca2c167dcb
3 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
include/psa/crypto.h
View file

@ -4267,22 +4267,26 @@ static psa_pake_operation_t psa_pake_operation_init(void);
* value derived from the password (eg. by a
* memory-hard function). It must remain valid
* until the operation terminates. It must be of
* type #PSA_KEY_TYPE_PASSWORD or
* 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).
* \param cipher_suite The cipher suite to use with the PAKE algorithm.
* \param side A value of type ::psa_pake_side_t signaling the
* side of the protocol that is being set up. For
* more information see the documentation of \c
* PSA_PAKE_SIDE_XXX constants.
* \param[in] user_id The user ID to authenticate with.
* \param user_id_length Size of the \p user_id buffer in bytes.
* \param user_id_len Size of the \p user_id buffer in bytes.
* \param[in] peer_id The peer's ID to authenticate.
* \param peer_id_length Size of the \p peer_id buffer in bytes.
* \param peer_id_len Size of the \p peer_id buffer in bytes.
* \param[in] session_data Additional session related data if it is allowed
* or required by the protocol. This must be empty
* if additional session data is not used by the
* protocol.
* \param session_data_length Size of the \p session_data buffer in bytes.
* \param session_data_len Size of the \p session_data buffer in bytes.
*
* \retval #PSA_SUCCESS
* Success.

6
include/psa/crypto_types.h
View file

@ -384,7 +384,11 @@ typedef uint16_t psa_key_derivation_step_t;
* @{
*/
/** \brief Encoding of the side of PAKE */
/** \brief Encoding of the side of PAKE
*
* Encodes which side of the protocol is being executed. For more information
* see the documentation of individual PSA_PAKE_SIDE_XXX constants.
*/
typedef uint16_t psa_pake_side_t;
/** Encoding of input and output indicators for PAKE.

4
include/psa/crypto_values.h
View file

@ -1969,7 +1969,7 @@
/** The Password-authenticated key exchange by juggling (J-PAKE) protocol.
*
* J-PAKE can be instantiated over finite fields or elliptic curves. This can
* be achieved by passing either #PSA_PAKE_PRIMITIVE_TYPE_FIELD or
* be achieved by passing either #PSA_PAKE_PRIMITIVE_TYPE_FIELD_DH or
* #PSA_PAKE_PRIMITIVE_TYPE_CURVE to #PSA_PAKE_PRIMITIVE respectively, when
* creating the cipher suite.
*
@ -2446,7 +2446,7 @@ static inline int mbedtls_svc_key_id_is_null( mbedtls_svc_key_id_t key )
/**@}*/
/** \defgroup pake Password-authenticated key exchange
/** \defgroup pake Password-authenticated key exchange (PAKE)
* @{
*/