cuberite/polarssl
1
0
Fork 0
mirror of https://github.com/cuberite/polarssl.git synced 2025-11-04 04:32:24 -05:00
Code Issues Packages Projects Releases Wiki Activity

Minor documentation and language fixes

Browse Source 
Signed-off-by: Steven Cooreman <steven.cooreman@silabs.com>
This commit is contained in:
Steven Cooreman 2021-05-06 19:23:00 +02:00
parent 3409b02b27
commit f45f071f01
1 changed files with 10 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
library/psa_crypto_mac.h
View File

@ -48,8 +48,6 @@
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The key is not compatible with \p alg.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported. * \p alg is not supported.
* \retval #PSA_ERROR_BUFFER_TOO_SMALL * \retval #PSA_ERROR_BUFFER_TOO_SMALL
@ -89,8 +87,6 @@ psa_status_t mbedtls_psa_mac_compute(
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The key is not compatible with \p alg.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported. * \p alg is not supported.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
@ -126,8 +122,6 @@ psa_status_t mbedtls_psa_mac_sign_setup(
* *
* \retval #PSA_SUCCESS * \retval #PSA_SUCCESS
* Success. * Success.
* \retval #PSA_ERROR_INVALID_ARGUMENT
* The key is not compatible with \p alg.
* \retval #PSA_ERROR_NOT_SUPPORTED * \retval #PSA_ERROR_NOT_SUPPORTED
* \p alg is not supported. * \p alg is not supported.
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
@ -149,11 +143,11 @@ psa_status_t mbedtls_psa_mac_verify_setup(
* defined in the PSA driver interface specification for transparent * defined in the PSA driver interface specification for transparent
* drivers. * drivers.
* *
* The core must call mbedtls_psa_mac_sign_setup() or * The PSA core calls mbedtls_psa_mac_sign_setup() or
* mbedtls_psa_mac_verify_setup() before calling this function. * mbedtls_psa_mac_verify_setup() before calling this function.
* *
* If this function returns an error status, the operation enters an error * If this function returns an error status, the PSA core aborts the
* state and must be aborted by calling psa_mac_abort(). * operation by calling mbedtls_psa_mac_abort().
* *
* \param[in,out] operation Active MAC operation. * \param[in,out] operation Active MAC operation.
* \param[in] input Buffer containing the message fragment to add to * \param[in] input Buffer containing the message fragment to add to
@ -179,13 +173,12 @@ psa_status_t mbedtls_psa_mac_update(
* defined in the PSA driver interface specification for transparent * defined in the PSA driver interface specification for transparent
* drivers. * drivers.
* *
* The core must call mbedtls_psa_mac_sign_setup() before calling this function. * The PSA core calls mbedtls_psa_mac_sign_setup() before calling this function.
* This function calculates the MAC of the message formed by concatenating * This function calculates the MAC of the message formed by concatenating
* the inputs passed to preceding calls to mbedtls_psa_mac_update(). * the inputs passed to preceding calls to mbedtls_psa_mac_update().
* *
* When this function returns successfully, the operation becomes inactive. * Whether this function returns successfully or not, the PSA core subsequently
* If this function returns an error status, the operation enters an error * aborts the operation by calling mbedtls_psa_mac_abort().
* state and must be aborted by calling mbedtls_psa_mac_abort().
* *
* \param[in,out] operation Active MAC operation. * \param[in,out] operation Active MAC operation.
* \param[out] mac Buffer where the MAC value is to be written. * \param[out] mac Buffer where the MAC value is to be written.
@ -222,15 +215,14 @@ psa_status_t mbedtls_psa_mac_sign_finish(
* mac_verify_finish entry point as defined in the PSA driver interface * mac_verify_finish entry point as defined in the PSA driver interface
* specification for transparent drivers. * specification for transparent drivers.
* *
* The core must call mbedtls_psa_mac_verify_setup() before calling this * The PSA core calls mbedtls_psa_mac_verify_setup() before calling this
* function. This function calculates the MAC of the message formed by * function. This function calculates the MAC of the message formed by
* concatenating the inputs passed to preceding calls to * concatenating the inputs passed to preceding calls to
* mbedtls_psa_mac_update(). It then compares the calculated MAC with the * mbedtls_psa_mac_update(). It then compares the calculated MAC with the
* expected MAC passed as a parameter to this function. * expected MAC passed as a parameter to this function.
* *
* When this function returns successfully, the operation becomes inactive. * Whether this function returns successfully or not, the PSA core subsequently
* If this function returns an error status, the operation enters an error * aborts the operation by calling mbedtls_psa_mac_abort().
* state and must be aborted by calling mbedtls_psa_mac_abort().
* *
* \param[in,out] operation Active MAC operation. * \param[in,out] operation Active MAC operation.
* \param[in] mac Buffer containing the expected MAC value. * \param[in] mac Buffer containing the expected MAC value.
@ -259,7 +251,7 @@ psa_status_t mbedtls_psa_mac_verify_finish(
* can be reused for another operation by calling * can be reused for another operation by calling
* mbedtls_psa_mac_sign_setup() or mbedtls_psa_mac_verify_setup() again. * mbedtls_psa_mac_sign_setup() or mbedtls_psa_mac_verify_setup() again.
* *
* The core may call this function any time after the operation object has * The PSA core may call this function any time after the operation object has
* been initialized by one of the methods described in * been initialized by one of the methods described in
* #mbedtls_psa_mac_operation_t. * #mbedtls_psa_mac_operation_t.
* *