mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-01-30 06:33:06 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Revert "Remove outdated doc on mbedtls_gcm_update()"

Browse Source 
This reverts commit 0be523356005960e07ead277dbf5354823a4afae.

Signed-off-by: Chien Wong <m@xv97.com>
This commit is contained in:
Chien Wong 2024-06-26 21:39:08 +08:00 committed by Harry Ramsey
parent c22de4aeba
commit ea2e5ebe4e
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
tf-psa-crypto/drivers/builtin/include/mbedtls/gcm.h
View File

@ -264,6 +264,22 @@ int mbedtls_gcm_update_ad(mbedtls_gcm_context *ctx,
* decrypt. After the last part of the input, call
* mbedtls_gcm_finish().
*
* This function may produce output in one of the following
* ways:
* - Immediate output: the output length is always equal
* to the input length.
* - Buffered output: the output consists of a whole number
* of 16-byte blocks. If the total input length so far
* (not including associated data) is 16 \* *B* + *A*
* with *A* < 16 then the total output length is 16 \* *B*.
*
* In particular:
* - It is always correct to call this function with
* \p output_size >= \p input_length + 15.
* - If \p input_length is a multiple of 16 for all the calls
* to this function during an operation, then it is
* correct to use \p output_size = \p input_length.
*
* \note The output buffer \p output can be the same as the input
* buffer \p input. If \p output is greater than \p input, they
* cannot overlap.
@ -277,6 +293,7 @@ int mbedtls_gcm_update_ad(mbedtls_gcm_context *ctx,
* is greater than zero, this must be a writable buffer of
* of at least \p output_size bytes.
* \param output_size The size of the output buffer in bytes.
* See the function description regarding the output size.
* \param output_length On success, \p *output_length contains the actual
* length of the output written in \p output.
* On failure, the content of \p *output_length is