commit d9380b5270afeef00aa5167225ad2771b2bf8c18
author Gilles Peskine <Gilles.Peskine@arm.com> Tue May 18 21:02:52 2021 +0200
committer Gilles Peskine <Gilles.Peskine@arm.com> Tue May 18 21:02:52 2021 +0200
tree e8497057ad75e7c0f65d7e346da56733497530d7
parent 8e8cdd150ac813739769bfb4a58aeaae51938e0c

Document reasons for MBEDTLS_ERR_GCM_BAD_INPUT in update and finish

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>

include/mbedtls/gcm.h

diff --git a/include/mbedtls/gcm.h b/include/mbedtls/gcm.h
index ae41c60..2e998e7 100644
--- a/include/mbedtls/gcm.h
+++ b/include/mbedtls/gcm.h
@@ -312,7 +312,10 @@
  *                      unspecified.
  *
  * \return         \c 0 on success.
- * \return         #MBEDTLS_ERR_GCM_BAD_INPUT on failure.
+ * \return         #MBEDTLS_ERR_GCM_BAD_INPUT on failure:
+ *                 total input length too long,
+ *                 unsupported input/output buffer overlap detected,
+ *                 or \p output_size too small.
  */
 int mbedtls_gcm_update( mbedtls_gcm_context *ctx,
                         const unsigned char *input, size_t input_length,
@@ -343,7 +346,9 @@
  *                  Alternative implementations may require a 15-byte buffer.
  *
  * \return          \c 0 on success.
- * \return          #MBEDTLS_ERR_GCM_BAD_INPUT on failure.
+ * \return          #MBEDTLS_ERR_GCM_BAD_INPUT on failure:
+ *                  invalid value of \p tag_len,
+ *                  or \p output_len too small.
  */
 int mbedtls_gcm_finish( mbedtls_gcm_context *ctx,
                         unsigned char *output, size_t output_len,