From 66f4101569c9536382d25a00f03a55e4ef3817e4 Mon Sep 17 00:00:00 2001 From: Kareem Date: Wed, 11 Oct 2023 16:12:34 -0700 Subject: [PATCH] Update documentation for wc_Shake256_Final to match function signature. --- doc/dox_comments/header_files/sha3.h | 11 ++++++----- wolfcrypt/src/sha3.c | 1 + 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/doc/dox_comments/header_files/sha3.h b/doc/dox_comments/header_files/sha3.h index ff6e4aed5..fbd38ceff 100644 --- a/doc/dox_comments/header_files/sha3.h +++ b/doc/dox_comments/header_files/sha3.h @@ -1010,7 +1010,7 @@ int wc_Shake128_Copy(wc_Shake* shake, wc_Shake* dst); } else { wc_Shake256_Update(shake, data, len); - wc_Shake256_Final(shake, hash); + wc_Shake256_Final(shake, hash, sizeof(hash)); } \endcode @@ -1043,7 +1043,7 @@ int wc_InitShake256(wc_Shake* shake, void* heap, int devId); } else { wc_Shake256_Update(shake, data, len); - wc_Shake256_Final(shake, hash); + wc_Shake256_Final(shake, hash, sizeof(hash)); } \endcode @@ -1063,6 +1063,7 @@ int wc_Shake256_Update(wc_Shake* sha, const byte* data, word32 len); \param shake pointer to the shake structure to use for encryption \param hash Byte array to hold hash value. + \param hashLen Size of hash in bytes. _Example_ \code @@ -1075,7 +1076,7 @@ int wc_Shake256_Update(wc_Shake* sha, const byte* data, word32 len); } else { wc_Shake256_Update(shake, data, len); - wc_Shake256_Final(shake, hash); + wc_Shake256_Final(shake, hash, sizeof(hash)); } \endcode @@ -1083,7 +1084,7 @@ int wc_Shake256_Update(wc_Shake* sha, const byte* data, word32 len); \sa wc_Shake256_GetHash \sa wc_InitShake256 */ -int wc_Shake256_Final(wc_Shake* shake, byte* hash); +int wc_Shake256_Final(wc_Shake* shake, byte* hash, word32 hashLen); /*! \ingroup SHA @@ -1175,7 +1176,7 @@ int wc_Shake256_SqueezeBlocks(wc_Shake* shake, byte* out, word32 blockCnt); } else { wc_Shake256_Update(&shake, data, len); - wc_Shake256_Final(&shake, hash); + wc_Shake256_Final(&shake, hash, sizeof(hash)); wc_Shake256_Free(&shake); } \endcode diff --git a/wolfcrypt/src/sha3.c b/wolfcrypt/src/sha3.c index 2baea7654..096566d28 100644 --- a/wolfcrypt/src/sha3.c +++ b/wolfcrypt/src/sha3.c @@ -1399,6 +1399,7 @@ int wc_Shake256_Update(wc_Shake* shake, const byte* data, word32 len) * * shake wc_Shake object holding state. * hash Buffer to hold the hash result. Must be at least 64 bytes. + * hashLen Size of hash in bytes. * returns 0 on success. */ int wc_Shake256_Final(wc_Shake* shake, byte* hash, word32 hashLen)