diff options
| author | Paul Duncan <pabs@pablotron.org> | 2023-09-04 02:31:12 -0400 |
|---|---|---|
| committer | Paul Duncan <pabs@pablotron.org> | 2023-09-04 02:31:12 -0400 |
| commit | e5562d9bb236d2e563d4385857651031f395fc7b (patch) | |
| tree | 342a9b408cf73ac5f0f74db1d1fb9ef9a2c1df6e | |
| parent | b806ec3beaea1d66c9b5abca2df1dd5d795d10a8 (diff) | |
| download | sha3-e5562d9bb236d2e563d4385857651031f395fc7b.tar.bz2 sha3-e5562d9bb236d2e563d4385857651031f395fc7b.zip | |
add README.md
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4e6c26e --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# sha3 + +[C11] implementations of the following [SHA-3][] algorithms from [FIPS 202][] and +[SP 800-185][800-185]: + +* SHA3-224 +* SHA3-256 +* SHA3-384 +* SHA3-512 +* SHAKE128 (fixed and XOF) +* SHAKE256 (fixed and XOF) +* cSHAKE128 (fixed and XOF) +* cSHAKE256 (fixed and XOF) +* KMAC128 (fixed and XOF) +* KMAC256 (fixed and XOF) +* TupleHash128 (fixed and XOF) +* TupleHash256 (fixed and XOF) +* ParallelHash128 (fixed and XOF) +* ParallelHash256 (fixed and XOF) + +Use `make` to build a minimal test application, and `make test` to run +the built-in tests. + +[C11]: https://en.wikipedia.org/wiki/C11_(C_standard_revision) + "ISO/IEC 9899:2011" +[SHA-3]: https://en.wikipedia.org/wiki/SHA-3 + "Secure Hash Algorithm 3" +[FIPS 202]: https://csrc.nist.gov/pubs/fips/202/final + "SHA-3 Standard: Permutation-Based Hash and Extendable-Output Functions" +[800-185]: https://csrc.nist.gov/pubs/sp/800/185/final + "SHA-3 Derived Functions: cSHAKE, KMAC, TupleHash, and ParallelHash" |