Skip to content

Commit 66f4101

Browse files
Update documentation for wc_Shake256_Final to match function signature.
1 parent 0e35e9c commit 66f4101

2 files changed

Lines changed: 7 additions & 5 deletions

File tree

doc/dox_comments/header_files/sha3.h

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,7 +1010,7 @@ int wc_Shake128_Copy(wc_Shake* shake, wc_Shake* dst);
10101010
}
10111011
else {
10121012
wc_Shake256_Update(shake, data, len);
1013-
wc_Shake256_Final(shake, hash);
1013+
wc_Shake256_Final(shake, hash, sizeof(hash));
10141014
}
10151015
\endcode
10161016
@@ -1043,7 +1043,7 @@ int wc_InitShake256(wc_Shake* shake, void* heap, int devId);
10431043
}
10441044
else {
10451045
wc_Shake256_Update(shake, data, len);
1046-
wc_Shake256_Final(shake, hash);
1046+
wc_Shake256_Final(shake, hash, sizeof(hash));
10471047
}
10481048
\endcode
10491049
@@ -1063,6 +1063,7 @@ int wc_Shake256_Update(wc_Shake* sha, const byte* data, word32 len);
10631063
10641064
\param shake pointer to the shake structure to use for encryption
10651065
\param hash Byte array to hold hash value.
1066+
\param hashLen Size of hash in bytes.
10661067
10671068
_Example_
10681069
\code
@@ -1075,15 +1076,15 @@ int wc_Shake256_Update(wc_Shake* sha, const byte* data, word32 len);
10751076
}
10761077
else {
10771078
wc_Shake256_Update(shake, data, len);
1078-
wc_Shake256_Final(shake, hash);
1079+
wc_Shake256_Final(shake, hash, sizeof(hash));
10791080
}
10801081
\endcode
10811082
10821083
\sa wc_Shake256Hash
10831084
\sa wc_Shake256_GetHash
10841085
\sa wc_InitShake256
10851086
*/
1086-
int wc_Shake256_Final(wc_Shake* shake, byte* hash);
1087+
int wc_Shake256_Final(wc_Shake* shake, byte* hash, word32 hashLen);
10871088

10881089
/*!
10891090
\ingroup SHA
@@ -1175,7 +1176,7 @@ int wc_Shake256_SqueezeBlocks(wc_Shake* shake, byte* out, word32 blockCnt);
11751176
}
11761177
else {
11771178
wc_Shake256_Update(&shake, data, len);
1178-
wc_Shake256_Final(&shake, hash);
1179+
wc_Shake256_Final(&shake, hash, sizeof(hash));
11791180
wc_Shake256_Free(&shake);
11801181
}
11811182
\endcode

wolfcrypt/src/sha3.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,6 +1399,7 @@ int wc_Shake256_Update(wc_Shake* shake, const byte* data, word32 len)
13991399
*
14001400
* shake wc_Shake object holding state.
14011401
* hash Buffer to hold the hash result. Must be at least 64 bytes.
1402+
* hashLen Size of hash in bytes.
14021403
* returns 0 on success.
14031404
*/
14041405
int wc_Shake256_Final(wc_Shake* shake, byte* hash, word32 hashLen)

0 commit comments

Comments
 (0)