yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-01-13 19:45:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse source 
Signed-off-by: gabor-mezei-arm <gabor.mezei@arm.com>
This commit is contained in:
gabor-mezei-arm 2021-06-25 15:43:07 +02:00
parent 3fd792d076
commit f4cc6c9064
No known key found for this signature in database
GPG key ID: 106F5A41ECC305BD
1 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
library/psa_crypto_cipher.h
View file

@ -213,14 +213,26 @@ psa_status_t mbedtls_psa_cipher_abort( mbedtls_psa_cipher_operation_t *operation
* \param[in] alg The cipher algorithm to compute * \param[in] alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that * (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true). * #PSA_ALG_IS_CIPHER(\p alg) is true).
* \param[in] input Buffer containing the iv and the plaintext. * \param[in] input Buffer containing the message to encrypt.
* \param[in] input_length Size of the \p input buffer in bytes. * \param[in] input_length Size of the \p input buffer in bytes.
* \param[in,out] output Buffer where the output is to be written. * \param[in,out] output Buffer where the output is to be written.
* The IV must be written to this buffer before * The core has generated and written the IV
* this function is called. * at the beginning of this buffer before
* \param[in] output_size Size of the \p output buffer in bytes. * this function is called. The size of the IV
* \param[out] output_length On success, the number of bytes * is PSA_CIPHER_IV_LENGTH( key_type, alg ) where
* that make up the returned output. * \c key_type is the type of the key identified
* by \p key and \p alg is the cipher algorithm
* to compute.
* \param[in] output_size Size of the \p output buffer in bytes. The core
* has checked that this size is greater or equal to
* PSA_CIPHER_ENCRYPT_OUTPUT_SIZE( key_type, alg, input_length )
* where \c key_type is the type of the key
* identified by \p key, \p alg is the cipher
* algorithm to compute and \p input_length is the
* size of the \p input buffer.
* \param[out] output_length On success, the number of bytes that make up
* the returned output. Initialized to zero
* by the core.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
@ -263,12 +275,20 @@ psa_status_t mbedtls_psa_cipher_encrypt( const psa_key_attributes_t *attributes,
* \param[in] alg The cipher algorithm to compute * \param[in] alg The cipher algorithm to compute
* (\c PSA_ALG_XXX value such that * (\c PSA_ALG_XXX value such that
* #PSA_ALG_IS_CIPHER(\p alg) is true). * #PSA_ALG_IS_CIPHER(\p alg) is true).
* \param[in] input Buffer containing the iv and the ciphertext. * \param[in] input Buffer containing the iv and the ciphertext.
* \param[in] input_length Size of the \p input buffer in bytes. * \param[in] input_length Size of the \p input buffer in bytes.
* \param[out] output Buffer where the output is to be written. * \param[out] output Buffer where the output is to be written.
* \param[in] output_size Size of the \p output buffer in bytes. * \param[in] output_size Size of the \p output buffer in bytes.
* \param[out] output_length On success, the number of bytes * The core has checked that this size is
* that make up the returned output. * greater or equal to
* PSA_CIPHER_DECRYPT_OUTPUT_SIZE( key_type, alg, input_length )
* where \c key_type is the type of the key
* identified by \p key, \p alg is the cipher
* algorithm to compute and \p input_length is the
* size of the \p input buffer.
* \param[out] output_length On success, the number of bytes that make up
* the returned output. Initialized to zero
* by the core.
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED