Merge pull request #9293 from dgpighin/docstrings_update

Some updates to the docstrings

Author: SparkiDev

wolfcrypt/src/dilithium.c

@@ -477,6 +477,9 @@ static int dilithium_shake256(wc_Shake* shake256, const byte* data,
 }
 
 /* 256-bit hash using SHAKE-256.
+ *
+ * This is the domain-separated version of the hash.
+ * See FIPS 204. D.3.
  *
  * FIPS 204. 8.3: H(v,d) <- SHAKE256(v,d)
  *
@@ -622,8 +625,8 @@ static int dilithium_hash256(wc_Shake* shake256, const byte* data1,
  *                            1 when message was hashed.
  * @param [in]      ctx       Context of signature.
  * @param [in]      ctxLen    Length of context of signature in bytes.
- * @param [in]      ctx       Message to sign.
- * @param [in]      ctxLen    Length of message to sign in bytes.
+ * @param [in]      msg       Message to sign.
+ * @param [in]      msgLen    Length of message to sign in bytes.
  * @param [out]     hash      Buffer to hold hash result.
  * @param [in]      hashLen   Number of bytes of hash to return.
  * @return  0 on success.
@@ -1038,7 +1041,7 @@ static void dilthium_vec_encode_eta_bits(const sword32* s, byte d, byte eta,
 #if !defined(WOLFSSL_NO_ML_DSA_44) || !defined(WOLFSSL_NO_ML_DSA_87)
 /* Decode polynomial with range -2..2.
  *
- * FIPS 204. 8.2: Algorithm 19 skDecode(sk)
+ * FIPS 204. 7.2: Algorithm 25 skDecode(sk)
  *   ...
  *   5: for i from 0 to l - 1 do
  *   6:     s1[i] <- BitUnpack(yi, eta, eta)
@@ -1099,7 +1102,7 @@ static void dilithium_decode_eta_2_bits(const byte* p, sword32* s)
 #ifndef WOLFSSL_NO_ML_DSA_65
 /* Decode polynomial with range -4..4.
  *
- * FIPS 204. 8.2: Algorithm 19 skDecode(sk)
+ * FIPS 204. 7.2: Algorithm 25 skDecode(sk)
  *   ...
  *   5: for i from 0 to l - 1 do
  *   6:     s1[i] <- BitUnpack(yi, eta, eta)
@@ -1173,7 +1176,7 @@ static void dilithium_decode_eta_4_bits(const byte* p, sword32* s)
       !defined(WOLFSSL_DILITHIUM_SIGN_SMALL_MEM)))
 /* Decode vector of polynomials with range -ETA..ETA.
  *
- * FIPS 204. 8.2: Algorithm 19 skDecode(sk)
+ * FIPS 204. 7.2: Algorithm 25 skDecode(sk)
  *   ...
  *   5: for i from 0 to l - 1 do
  *   6:     s1[i] <- BitUnpack(yi, eta, eta)
@@ -1382,7 +1385,7 @@ static void dilithium_vec_encode_t0_t1(const sword32* t, byte d, byte* t0,
 #if !defined(WOLFSSL_DILITHIUM_NO_SIGN) || defined(WOLFSSL_DILITHIUM_CHECK_KEY)
 /* Decode bottom D bits of t as t0.
  *
- * FIPS 204. 8.2: Algorithm 19 skDecode(sk)
+ * FIPS 204. 7.2: Algorithm 25 skDecode(sk)
  *   ...
  *   12:     t0[i] <- BitUnpack(wi, 2^(d-1) - 1, 2^(d-1)
  *   ...
@@ -1482,7 +1485,7 @@ static void dilithium_decode_t0(const byte* t0, sword32* t)
       !defined(WOLFSSL_DILITHIUM_SIGN_SMALL_MEM)))
 /* Decode bottom D bits of t as t0.
  *
- * FIPS 204. 8.2: Algorithm 19 skDecode(sk)
+ * FIPS 204. 7.2: Algorithm 25 skDecode(sk)
  *   ...
  *   11: for i from 0 to k - 1 do
  *   12:     t0[i] <- BitUnpack(wi, 2^(d-1) - 1, 2^(d-1)
@@ -1512,7 +1515,7 @@ static void dilithium_vec_decode_t0(const byte* t0, byte d, sword32* t)
     defined(WOLFSSL_DILITHIUM_CHECK_KEY)
 /* Decode top bits of t as t1.
  *
- * FIPS 204. 8.2: Algorithm 17 pkDecode(pk)
+ * FIPS 204. 7.2: Algorithm 23 pkDecode(pk)
  *   ...
  *   4:     t1[i] <- SimpleBitUnpack(zi, 2^(bitlen(q-1)-d) - 1)
  *   ...
@@ -1585,7 +1588,7 @@ static void dilithium_decode_t1_c(const byte* t1, sword32* t)
 
 /* Decode top bits of t as t1.
  *
- * FIPS 204. 8.2: Algorithm 17 pkDecode(pk)
+ * FIPS 204. 7.2: Algorithm 23 pkDecode(pk)
  *   ...
  *   4:     t1[i] <- SimpleBitUnpack(zi, 2^(bitlen(q-1)-d) - 1)
  *   ...
@@ -1613,7 +1616,7 @@ static void dilithium_decode_t1(const byte* t1, sword32* t)
     defined(WOLFSSL_DILITHIUM_CHECK_KEY)
 /* Decode top bits of t as t1.
  *
- * FIPS 204. 8.2: Algorithm 17 pkDecode(pk)
+ * FIPS 204. 7.2: Algorithm 23 pkDecode(pk)
  *   ...
  *   3: for i from 0 to k - 1 do
  *   4:     t1[i] <- SimpleBitUnpack(zi, 2^(bitlen(q-1)-d) - 1)