From 3a11bb82131c266018486b50c004f409497992b2 Mon Sep 17 00:00:00 2001 From: Tom Cosgrove Date: Tue, 18 Jul 2023 16:26:29 +0100 Subject: [PATCH] Better wording around passing NULL to mbedtls_zeroize_and_free() Signed-off-by: Tom Cosgrove --- library/common.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/library/common.h b/library/common.h index ce92238c88..b68089e188 100644 --- a/library/common.h +++ b/library/common.h @@ -117,11 +117,13 @@ extern void (*mbedtls_test_hook_test_fail)(const char *test, int line, const cha /** * \brief Securely zeroize a buffer then free it. * - * Exactly the same as consecutive calls to - * \c mbedtls_platform_zeroize() and \c mbedtls_free(), but has a + * Similar to making consecutive calls to + * \c mbedtls_platform_zeroize() and \c mbedtls_free(), but has * code size savings, and potential for optimisation in the future. * - * \param buf Buffer to be zeroized then freed. May be \c NULL. + * Guaranteed to be a no-op if \p buf is \c NULL and \p len is 0. + * + * \param buf Buffer to be zeroized then freed. * \param len Length of the buffer in bytes */ void mbedtls_zeroize_and_free(void *buf, size_t len);