eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove linkage documentation on PAKE cipher-suite helpers

Browse source 
Signed-off-by: Neil Armstrong <narmstrong@baylibre.com>
This commit is contained in:
Neil Armstrong 2022-05-30 15:49:21 +02:00
parent 5ed8a0ec73
commit ccffab38a3
1 changed files with 0 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

32
include/psa/crypto_extra.h
View file

@ -1165,10 +1165,6 @@ typedef struct psa_pake_cipher_suite_s psa_pake_cipher_suite_t;
static psa_pake_cipher_suite_t psa_pake_cipher_suite_init( void ); static psa_pake_cipher_suite_t psa_pake_cipher_suite_init( void );
/** Retrieve the PAKE algorithm from a PAKE cipher suite. /** Retrieve the PAKE algorithm 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 must evaluate its argument exactly once.
* *
* \param[in] cipher_suite The cipher suite structure to query. * \param[in] cipher_suite The cipher suite structure to query.
* *
@ -1182,10 +1178,6 @@ static psa_algorithm_t psa_pake_cs_get_algorithm(
* This function overwrites any PAKE algorithm * This function overwrites any PAKE algorithm
* previously set in \p cipher_suite. * previously set in \p 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 must evaluate each of its arguments exactly once.
*
* \param[out] cipher_suite The cipher suite structure to write to. * \param[out] cipher_suite The cipher suite structure to write to.
* \param algorithm The PAKE algorithm to write. * \param algorithm The PAKE algorithm to write.
* (`PSA_ALG_XXX` values of type ::psa_algorithm_t * (`PSA_ALG_XXX` values of type ::psa_algorithm_t
@ -1197,10 +1189,6 @@ static void psa_pake_cs_set_algorithm( psa_pake_cipher_suite_t *cipher_suite,
psa_algorithm_t algorithm ); psa_algorithm_t algorithm );
/** Retrieve the primitive 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
* must evaluate its argument exactly once.
* *
* \param[in] cipher_suite The cipher suite structure to query. * \param[in] cipher_suite The cipher suite structure to query.
* *
@ -1213,10 +1201,6 @@ static psa_pake_primitive_t psa_pake_cs_get_primitive(
* *
* This function overwrites any primitive previously set in \p cipher_suite. * This function overwrites any primitive previously set in \p 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 must evaluate each of its arguments exactly once.
*
* \param[out] cipher_suite The cipher suite structure to write to. * \param[out] cipher_suite The cipher suite structure to write to.
* \param primitive The primitive to write. If this is 0, the * \param primitive The primitive to write. If this is 0, the
* primitive type in \p cipher_suite becomes * primitive type in \p cipher_suite becomes
@ -1226,10 +1210,6 @@ static void psa_pake_cs_set_primitive( psa_pake_cipher_suite_t *cipher_suite,
psa_pake_primitive_t primitive ); psa_pake_primitive_t primitive );
/** Retrieve the PAKE family from a PAKE cipher suite. /** Retrieve the PAKE family 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 must evaluate its argument exactly once.
* *
* \param[in] cipher_suite The cipher suite structure to query. * \param[in] cipher_suite The cipher suite structure to query.
* *
@ -1239,10 +1219,6 @@ static psa_pake_family_t psa_pake_cs_get_family(
const psa_pake_cipher_suite_t *cipher_suite ); const psa_pake_cipher_suite_t *cipher_suite );
/** Retrieve the PAKE primitive bit-size from a PAKE cipher suite. /** Retrieve the PAKE primitive bit-size 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 must evaluate its argument exactly once.
* *
* \param[in] cipher_suite The cipher suite structure to query. * \param[in] cipher_suite The cipher suite structure to query.
* *
@ -1252,10 +1228,6 @@ static uint16_t psa_pake_cs_get_bits(
const psa_pake_cipher_suite_t *cipher_suite ); const psa_pake_cipher_suite_t *cipher_suite );
/** Retrieve the hash algorithm from a PAKE cipher suite. /** Retrieve the hash algorithm 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 must evaluate its argument exactly once.
* *
* \param[in] cipher_suite The cipher suite structure to query. * \param[in] cipher_suite The cipher suite structure to query.
* *
@ -1271,10 +1243,6 @@ static psa_algorithm_t psa_pake_cs_get_hash(
* This function overwrites any hash algorithm * This function overwrites any hash algorithm
* previously set in \p cipher_suite. * previously set in \p 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 must evaluate each of its arguments exactly once.
*
* 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)
* for more information. * for more information.