Update GCM buffer overlap documentation

This commit updates the GCM buffer overlap documentation to explicity
state that alternative implementations may not support input/output
buffer overlap for GCM encrypt/decrypt functions.

Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
This commit is contained in:
Harry Ramsey 2024-10-08 10:31:03 +01:00
parent 099623c8e9
commit af3962491d

View File

@ -174,7 +174,9 @@ int mbedtls_gcm_crypt_and_tag(mbedtls_gcm_context *ctx,
*
* \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.
* cannot overlap. Implementations which require
* MBEDTLS_GCM_ALT to be enabled may not provide support
* overlapping buffers.
*
* \param ctx The GCM context. This must be initialized.
* \param length The length of the ciphertext to decrypt, which is also
@ -282,7 +284,9 @@ int mbedtls_gcm_update_ad(mbedtls_gcm_context *ctx,
*
* \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.
* cannot overlap. Implementations which require
* MBEDTLS_GCM_ALT to be enabled may not provide support
* overlapping buffers.
*
* \param ctx The GCM context. This must be initialized.
* \param input The buffer holding the input data. If \p input_length