Fix documentation for GCM decryption functions

This commit fixes documentation specifying buffer overlap on GCM decryption functions. Signed-off-by: Harry Ramsey <[email protected]>
Mbed-TLS · Nov 13, 2024 · 9892d14 · 9892d14
1 parent d77207e
commit 9892d14
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/include/mbedtls/gcm.h b/include/mbedtls/gcm.h
@@ -178,9 +178,11 @@ int mbedtls_gcm_crypt_and_tag(mbedtls_gcm_context *ctx,
  * \brief           This function performs a GCM authenticated decryption of a
  *                  buffer.
  *
- * \note            For decryption, the output buffer cannot be the same as
- *                  input buffer. If the buffers overlap, the output buffer
- *                  must trail at least 8 Bytes behind the input buffer.
+ * \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. Implementations which require
+ *                  MBEDTLS_GCM_ALT to be enabled may not provide support for
+ *                  overlapping buffers.
  *
  * \param ctx       The GCM context. This must be initialized.
  * \param length    The length of the ciphertext to decrypt, which is also
@@ -289,8 +291,8 @@ 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. Implementations which require
- *                  MBEDTLS_GCM_ALT //no-check-names to be enabled may not
- *                  provide support for overlapping buffers.
+ *                  MBEDTLS_GCM_ALT to be enabled may not provide support for
+ *                  overlapping buffers.
  *
  * \param ctx           The GCM context. This must be initialized.
  * \param input         The buffer holding the input data. If \p input_length