mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-03-24 10:43:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Align mbedtls_ccm_update_ad() and mbedtls_ccm_update() descriptions

Browse Source 
Signed-off-by: Ronald Cron <ronald.cron@arm.com>
This commit is contained in:
Ronald Cron 2021-05-26 09:49:11 +02:00
parent 5905f91ba1
commit d1a29a9687
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/mbedtls/ccm.h
View File

@ -326,14 +326,13 @@ int mbedtls_ccm_starts( mbedtls_ccm_context *ctx,
* (authenticated but not encrypted data) in a CCM * (authenticated but not encrypted data) in a CCM
* encryption or decryption operation. * encryption or decryption operation.
* *
* Call this function after mbedtls_ccm_starts() to pass * You may call this function zero, one or more times
* the associated data. If the associated data is empty, * to pass successive parts of the additional data. The
* you do not need to call this function. You may not * lengths \p add_len of the data parts should eventually add
* up exactly to the total length of additional data
* \c total_ad_len passed to mbedtls_ccm_starts(). You may not
* call this function after calling mbedtls_ccm_update(). * call this function after calling mbedtls_ccm_update().
* *
* \note This function may be called several times per operation,
* passing the associated data in chunks.
*
* \param ctx The CCM context. This must have been started with * \param ctx The CCM context. This must have been started with
* mbedtls_ccm_starts() and must not have yet received * mbedtls_ccm_starts() and must not have yet received
* any input with mbedtls_ccm_update(). * any input with mbedtls_ccm_update().
@ -358,7 +357,10 @@ int mbedtls_ccm_update_ad( mbedtls_ccm_context *ctx,
* to pass successive parts of the input: the plaintext to * to pass successive parts of the input: the plaintext to
* encrypt, or the ciphertext (not including the tag) to * encrypt, or the ciphertext (not including the tag) to
* decrypt. After the last part of the input, call * decrypt. After the last part of the input, call
* mbedtls_ccm_finish(). * mbedtls_ccm_finish(). The lengths \p input_length of the
* data parts should eventually add up exactly to the total
* length of input data \c total_input_len passed to
* mbedtls_ccm_starts().
* *
* This function may produce output in one of the following * This function may produce output in one of the following
* ways: * ways: