mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2025-01-11 19:55:32 +00:00
psa: Document generator requirements consistently
We've added documentation for how context objects for multi-part operations must be initialized consistently for key policy, hash, cipher, and MAC. Update the generator documentation to be consistent with how we've documented the other operations.
This commit is contained in:
parent
d94d671f14
commit
9e919c636f
|
@ -2099,11 +2099,9 @@ psa_status_t psa_generator_abort(psa_crypto_generator_t *generator);
|
||||||
* - For HKDF (#PSA_ALG_HKDF), \p salt is the salt used in the "extract" step
|
* - For HKDF (#PSA_ALG_HKDF), \p salt is the salt used in the "extract" step
|
||||||
* and \p label is the info string used in the "expand" step.
|
* and \p label is the info string used in the "expand" step.
|
||||||
*
|
*
|
||||||
* \param[in,out] generator The generator object to set up. It must
|
* \param[in,out] generator The generator object to set up. It must have
|
||||||
* have been initialized to all-bits-zero,
|
* been initialized as per the documentation for
|
||||||
* a logical zero (`{0}`),
|
* #psa_crypto_generator_t and not yet in use.
|
||||||
* \c PSA_CRYPTO_GENERATOR_INIT or
|
|
||||||
* psa_crypto_generator_init().
|
|
||||||
* \param handle Handle to the secret key.
|
* \param handle Handle to the secret key.
|
||||||
* \param alg The key derivation algorithm to compute
|
* \param alg The key derivation algorithm to compute
|
||||||
* (\c PSA_ALG_XXX value such that
|
* (\c PSA_ALG_XXX value such that
|
||||||
|
@ -2153,11 +2151,9 @@ psa_status_t psa_key_derivation(psa_crypto_generator_t *generator,
|
||||||
* The resulting generator always has the maximum capacity permitted by
|
* The resulting generator always has the maximum capacity permitted by
|
||||||
* the algorithm.
|
* the algorithm.
|
||||||
*
|
*
|
||||||
* \param[in,out] generator The generator object to set up. It must
|
* \param[in,out] generator The generator object to set up. It must have
|
||||||
* have been initialized to all-bits-zero,
|
* been initialized as per the documentation for
|
||||||
* a logical zero (`{0}`),
|
* #psa_crypto_generator_t and not yet in use.
|
||||||
* \c PSA_CRYPTO_GENERATOR_INIT or
|
|
||||||
* psa_crypto_generator_init().
|
|
||||||
* \param private_key Handle to the private key to use.
|
* \param private_key Handle to the private key to use.
|
||||||
* \param[in] peer_key Public key of the peer. It must be
|
* \param[in] peer_key Public key of the peer. It must be
|
||||||
* in the same format that psa_import_key()
|
* in the same format that psa_import_key()
|
||||||
|
|
Loading…
Reference in a new issue