Mbed-TLS/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2026-10-02 15:07:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some API calling order documentation

Browse Source 
Signed-off-by: Ronald Cron <[email protected]>
This commit is contained in:
Ronald Cron
2021-06-01 09:22:05 +02:00
parent f668bd18df
commit 542957d6b1
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/mbedtls/ccm.h
+10
View File
@@ -297,6 +297,11 @@ int mbedtls_ccm_star_auth_decrypt( mbedtls_ccm_context *ctx, size_t length,
* \brief This function starts a CCM encryption or decryption * \brief This function starts a CCM encryption or decryption
* operation. * operation.
* *
* This function and mbedtls_ccm_set_lengths() must be called
* before calling mbedtls_ccm_update_ad() or
* mbedtls_ccm_update(). This function can be called before
* or after mbedtls_ccm_set_lengths().
*
* \note This function is not implemented in Mbed TLS yet. * \note This function is not implemented in Mbed TLS yet.
* *
* \param ctx The CCM context. This must be initialized. * \param ctx The CCM context. This must be initialized.
@@ -325,6 +330,11 @@ int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
* and additional data for a CCM encryption or decryption * and additional data for a CCM encryption or decryption
* operation. * operation.
* *
* This function and mbedtls_ccm_starts() must be called
* before calling mbedtls_ccm_update_ad() or
* mbedtls_ccm_update(). This function can be called before
* or after mbedtls_ccm_starts().
*
* \note This function is not implemented in Mbed TLS yet. * \note This function is not implemented in Mbed TLS yet.
* *
* \param ctx The CCM context. This must be initialized. * \param ctx The CCM context. This must be initialized.