SHA-512: add ref to NIST standard

JuliaCrypto · Jan 15, 2024 · a658829 · a658829
1 parent 11a4c73
commit a658829
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 3 deletions.
diff --git a/src/constants.jl b/src/constants.jl
@@ -1,4 +1,8 @@
-# SHA initial hash values and constants
+"""SHA initial hash values and constants
+
+Reference:
+- SHA-1, SHA2: FIPS 180-4: https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf
+"""
 
 # Hash constant words K for SHA1
 const K1 = UInt32[

diff --git a/src/types.jl b/src/types.jl
@@ -198,13 +198,19 @@ SHA2_512_CTX() = SHA2_512_CTX(copy(SHA2_512_initial_hash_value), 0, zeros(UInt8,
 """
     SHA2_512_224_CTX()
 
-Construct an empty SHA2_512/224 context.
+Construct an empty SHA2_512/224 context and set the initial hash value.
+
+For the source of the initial value,
+refer to [FIPS 180-4, 5.3.6.1 SHA-512/224](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf)
 """
 SHA2_512_224_CTX() = SHA2_512_224_CTX(copy(SHA2_512_224_initial_hash_value), 0, zeros(UInt8, blocklen(SHA2_512_224_CTX)), false)
 """
     SHA2_512_256_CTX()
 
-Construct an empty SHA2_512/256 context.
+Construct an empty SHA2_512/256 context and set the initial hash value.
+
+For the source of the initial value,
+refer to [FIPS 180-4, 5.3.6.2 SHA-512/256](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf)
 """
 SHA2_512_256_CTX() = SHA2_512_256_CTX(copy(SHA2_512_256_initial_hash_value), 0, zeros(UInt8, blocklen(SHA2_512_256_CTX)), false)