From eabfa98ef917ac3bf6a0d8beec8492763c9333a0 Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Fri, 18 Oct 2024 21:25:06 +0300 Subject: [PATCH] Update documentation --- README.md | 4 ++-- doc/hash2/overview.adoc | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eefc0f8..f0445f5 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,8 @@ It also contains implementations of several popular hashing algorithms: * [SipHash](https://131002.net/siphash/) * [MD5](https://tools.ietf.org/html/rfc1321) * [SHA-1](https://tools.ietf.org/html/rfc3174) -* [HMAC-MD5 and HMAC-SHA1](https://tools.ietf.org/html/rfc2104) +* [SHA-2](https://tools.ietf.org/html/rfc6234) +* [HMAC-MD5, HMAC-SHA1, HMAC-SHA2](https://tools.ietf.org/html/rfc2104) The hashing algorithms conform to the following concept: @@ -53,7 +54,6 @@ None yet. ## Planned Additions * Documentation (obv.) -* SHA2-256, 384, 512 * Support for endian-independent hashing * A `std::hash`-compatible adaptor * A type-erased `hash_function` diff --git a/doc/hash2/overview.adoc b/doc/hash2/overview.adoc index f6a7400..3f4d316 100644 --- a/doc/hash2/overview.adoc +++ b/doc/hash2/overview.adoc @@ -30,7 +30,8 @@ The following popular hashing algorithms are provided: * https://131002.net/siphash/[SipHash] * https://tools.ietf.org/html/rfc1321[MD5] * https://tools.ietf.org/html/rfc3174[SHA-1] -* https://tools.ietf.org/html/rfc2104[HMAC-MD5 and HMAC-SHA1] +* https://tools.ietf.org/html/rfc6234[SHA-2] +* https://tools.ietf.org/html/rfc2104[HMAC-MD5, HMAC-SHA1, HMAC-SHA2] but it's also possible for users to write their own; as long as the hash algorithm conforms to the concept, `hash_append` will work with it,