wolfSSL/wolfssl
1
0
Fork 1
mirror of https://github.com/wolfSSL/wolfssl.git synced 2025-07-30 18:57:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation for wc_Shake256_Final to match function signature.

Browse Source
This commit is contained in:
Kareem
2023-10-11 16:12:34 -07:00
parent 0e35e9cbbe
commit 66f4101569
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/dox_comments/header_files/sha3.h
View File

@ -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

1
wolfcrypt/src/sha3.c
View File

@ -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)