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

Better wording around passing NULL to mbedtls_zeroize_and_free()

Browse Source 
Signed-off-by: Tom Cosgrove <tom.cosgrove@arm.com>
This commit is contained in:
Tom Cosgrove 2023-07-18 16:26:29 +01:00
parent ca8c61b815
commit 3a11bb8213
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
library/common.h
View File

@ -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. * \brief Securely zeroize a buffer then free it.
* *
* Exactly the same as consecutive calls to * Similar to making consecutive calls to
* \c mbedtls_platform_zeroize() and \c mbedtls_free(), but has a * \c mbedtls_platform_zeroize() and \c mbedtls_free(), but has
* code size savings, and potential for optimisation in the future. * 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 * \param len Length of the buffer in bytes
*/ */
void mbedtls_zeroize_and_free(void *buf, size_t len); void mbedtls_zeroize_and_free(void *buf, size_t len);