feedc0de/wolfssl
1
0
Fork 0
forked from wolfSSL/wolfssl
Code Pull Requests Activity

Merge pull request #8102 from embhorn/topic2203

Browse Source 
Fix docs for invalid hash requirements.
This commit is contained in:
David Garske
2024-10-30 15:15:19 -07:00
committed by GitHub
parent 72306b9a67 f20f96c8a2
commit fc56060873
2 changed files with 3 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/dox_comments/header_files/ed25519.h
View File

@ -188,8 +188,7 @@ int wc_ed25519ctx_sign_msg(const byte* in, word32 inlen, byte* out,
\brief This function signs a message digest using an ed25519_key object \brief This function signs a message digest using an ed25519_key object
to guarantee authenticity. The context is included as part of the data to guarantee authenticity. The context is included as part of the data
signed. The message is pre-hashed before signature calculation. The hash signed. The message is pre-hashed before signature calculation.
algorithm used to create message digest must be SHAKE-256.
\return 0 Returned upon successfully generating a signature for the \return 0 Returned upon successfully generating a signature for the
message digest. message digest.

6
doc/dox_comments/header_files/ed448.h
View File

@ -133,7 +133,6 @@ int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
\brief This function signs a message digest using an ed448_key object \brief This function signs a message digest using an ed448_key object
to guarantee authenticity. The context is included as part of the data to guarantee authenticity. The context is included as part of the data
signed. The hash is the pre-hashed message before signature calculation. signed. The hash is the pre-hashed message before signature calculation.
The hash algorithm used to create message digest must be SHAKE-256.
\return 0 Returned upon successfully generating a signature for the \return 0 Returned upon successfully generating a signature for the
message digest. message digest.
@ -162,7 +161,7 @@ int wc_ed448_sign_msg(const byte* in, word32 inlen, byte* out,
byte sig[114]; // will hold generated signature byte sig[114]; // will hold generated signature
sigSz = sizeof(sig); sigSz = sizeof(sig);
byte hash[] = { initialize with SHAKE-256 hash of message }; byte hash[] = { initialize hash of message };
byte context[] = { initialize with context of signing }; byte context[] = { initialize with context of signing };
wc_InitRng(&rng); // initialize rng wc_InitRng(&rng); // initialize rng
@ -297,7 +296,6 @@ int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg,
\brief This function verifies the Ed448 signature of the digest of a message \brief This function verifies the Ed448 signature of the digest of a message
to ensure authenticity. The context is included as part of the data to ensure authenticity. The context is included as part of the data
verified. The hash is the pre-hashed message before signature calculation. verified. The hash is the pre-hashed message before signature calculation.
The hash algorithm used to create message digest must be SHAKE-256.
The answer is returned through res, with 1 corresponding to a valid The answer is returned through res, with 1 corresponding to a valid
signature, and 0 corresponding to an invalid signature. signature, and 0 corresponding to an invalid signature.
@ -325,7 +323,7 @@ int wc_ed448_verify_msg(const byte* sig, word32 siglen, const byte* msg,
int ret, verified = 0; int ret, verified = 0;
byte sig[] { initialize with received signature }; byte sig[] { initialize with received signature };
byte hash[] = { initialize with SHAKE-256 hash of message }; byte hash[] = { initialize hash of message };
byte context[] = { initialize with context of signature }; byte context[] = { initialize with context of signature };
// initialize key with received public key // initialize key with received public key
ret = wc_ed448ph_verify_hash(sig, sizeof(sig), hash, sizeof(hash), ret = wc_ed448ph_verify_hash(sig, sizeof(sig), hash, sizeof(hash),