Skip to content

Commit b3bb8ed

Browse files
committed
Fix doc for wc_ecc_verify_hash / _ex
1 parent 8316a40 commit b3bb8ed

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

  • doc/dox_comments/header_files

doc/dox_comments/header_files/ecc.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -543,12 +543,12 @@ int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
543543
\ingroup ECC
544544
545545
\brief This function verifies the ECC signature of a hash to ensure
546-
authenticity. It returns the answer through stat, with 1 corresponding
546+
authenticity. It returns the answer through res, with 1 corresponding
547547
to a valid signature, and 0 corresponding to an invalid signature.
548548
549549
\return 0 Returned upon successfully performing the signature
550550
verification. Note: This does not mean that the signature is verified.
551-
The authenticity information is stored instead in stat
551+
The authenticity information is stored instead in res
552552
\return BAD_FUNC_ARG Returned any of the input parameters evaluate to NULL
553553
\return MEMORY_E Returned if there is an error allocating memory
554554
\return MP_INIT_E may be returned if there is an error while computing
@@ -579,7 +579,7 @@ int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
579579
\param hash pointer to the buffer containing the hash of the message
580580
verified
581581
\param hashlen length of the hash of the message verified
582-
\param stat pointer to the result of the verification. 1 indicates the
582+
\param res pointer to the result of the verification. 1 indicates the
583583
message was successfully verified
584584
\param key pointer to a public ECC key with which to verify the signature
585585
@@ -605,14 +605,14 @@ int wc_ecc_sign_hash_ex(const byte* in, word32 inlen, WC_RNG* rng,
605605
*/
606606

607607
int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash,
608-
word32 hashlen, int* stat, ecc_key* key);
608+
word32 hashlen, int* res, ecc_key* key);
609609

610610
/*!
611611
\ingroup ECC
612612
613-
\brief Verify an ECC signature. Result is written to stat.
613+
\brief Verify an ECC signature. Result is written to res.
614614
1 is valid, 0 is invalid.
615-
Note: Do not use the return value to test for valid. Only use stat.
615+
Note: Do not use the return value to test for valid. Only use res.
616616
617617
\return MP_OKAY If successful (even if the signature is not valid)
618618
\return ECC_BAD_ARG_E Returns if arguments are null or if
@@ -623,28 +623,28 @@ int wc_ecc_verify_hash(const byte* sig, word32 siglen, const byte* hash,
623623
\param s The signature S component to verify
624624
\param hash The hash (message digest) that was signed
625625
\param hashlen The length of the hash (octets)
626-
\param stat Result of signature, 1==valid, 0==invalid
626+
\param res Result of signature, 1==valid, 0==invalid
627627
\param key The corresponding public ECC key
628628
629629
_Example_
630630
\code
631631
mp_int r;
632632
mp_int s;
633-
int stat;
633+
int res;
634634
byte hash[] = { Some hash }
635635
ecc_key key;
636636
637-
if(wc_ecc_verify_hash_ex(&r, &s, hash, hashlen, &stat, &key) == MP_OKAY)
637+
if(wc_ecc_verify_hash_ex(&r, &s, hash, hashlen, &res, &key) == MP_OKAY)
638638
{
639-
// Check stat
639+
// Check res
640640
}
641641
\endcode
642642
643643
\sa wc_ecc_verify_hash
644644
*/
645645

646646
int wc_ecc_verify_hash_ex(mp_int *r, mp_int *s, const byte* hash,
647-
word32 hashlen, int* stat, ecc_key* key);
647+
word32 hashlen, int* res, ecc_key* key);
648648

649649
/*!
650650
\ingroup ECC
@@ -1783,7 +1783,7 @@ int wc_ecc_ctx_set_algo(ecEncCtx* ctx, byte encAlgo, byte kdfAlgo,
17831783
\sa wc_ecc_ctx_set_kdf_salt
17841784
*/
17851785

1786-
const byte* wc_ecc_ctx_get_own_salt(ecEncCtx*);
1786+
const byte* wc_ecc_ctx_get_own_salt(ecEncCtx* ctx);
17871787

17881788
/*!
17891789
\ingroup ECC

0 commit comments

Comments
 (0)