sha2: clarify documentation #112

GaloisInc · Aug 23, 2024 · 54cd534 · 54cd534
1 parent 166d28a
commit 54cd534
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/Primitive/Keyless/Hash/SHA2/Instantiations/SHA256.cry b/Primitive/Keyless/Hash/SHA2/Instantiations/SHA256.cry
@@ -1,5 +1,6 @@
 /**
- * Secure hash algorithm SHA-256 as specified in [FIPS-180-4].
+ * Instantiation of the secure hash algorithm SHA-256 as specified in
+ * [FIPS-180-4], Section 5.3.3.
  *
  * @copyright Galois, Inc
  * @author Marcella Hastings <[email protected]>

diff --git a/Primitive/Keyless/Hash/SHA2/Instantiations/SHA384.cry b/Primitive/Keyless/Hash/SHA2/Instantiations/SHA384.cry
@@ -1,5 +1,6 @@
 /**
- * Secure hash algorithm SHA-384 as specified in [FIPS-180-4].
+ * Instantiation of the secure hash algorithm SHA-384 as specified in
+ * [FIPS-180-4], Section 5.3.4.
  *
  * @copyright Galois, Inc
  * @author Marcella Hastings <[email protected]>

diff --git a/Primitive/Keyless/Hash/SHA2/Instantiations/SHA512.cry b/Primitive/Keyless/Hash/SHA2/Instantiations/SHA512.cry
@@ -1,5 +1,6 @@
 /**
- * Secure hash algorithm SHA-512 as specified in [FIPS-180-4].
+ * Instantiation of the secure hash algorithm SHA-512 as specified in
+ * [FIPS-180-4], Section 5.3.5.
  *
  * @copyright Galois, Inc
  * @author Marcella Hastings <[email protected]>

diff --git a/Primitive/Keyless/Hash/SHA2/Specification.cry b/Primitive/Keyless/Hash/SHA2/Specification.cry
@@ -26,7 +26,9 @@ parameter
     /**
      * Length of words, in bits, that are used during hashing.
      *
-     * The specification defines words to be either 32 or 64 bits.
+     * The specification defines words to be either 32 bits (for
+     * SHA-224 and SHA-256) or 64 bits (for SHA-384, SHA-512, and
+     * SHA-512/t for any valid `t`).
      * [FIPS-180-4] Section 1, Figure 1.
      */
     type w : #