]> git.codecow.com Git - Monocypher.git/commitdiff
Advertise Monocypher's features more clearly
authorLoup Vaillant <loup@loup-vaillant.fr>
Fri, 4 Jun 2021 21:21:23 +0000 (23:21 +0200)
committerLoup Vaillant <loup@loup-vaillant.fr>
Fri, 4 Jun 2021 21:21:23 +0000 (23:21 +0200)
For the second time, I've stumbled upon a user that believed Monocypher
did not support public key cryptography, despite the presence of a
fairly high-level key exchange API.

Looking at the README and website, I noticed that while key exchange is
fairly well publicised, "public key cryptography" is not.  I suspect
many users simply don't know that key exchange is a valid way to do
public key cryptography.  In hindsihght, we should not expected them to.

Let's not dwell on how many potential users we may have lost to this
oversight.  Hopefully, writing "Public key cryptography" directly will
help people notice.

README.md

index 2118b5f47f8705ac2a50551e6350a7ad0a132a56..217df5d2fd1b63fe27cce7d319c4b929e17dbff2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -25,6 +25,29 @@ speed of [Libsodium][].
 [Libsodium]: https://libsodium.org
 [TweetNaCl]: https://tweetnacl.cr.yp.to/
 
+
+Features
+--------
+
+- [Authenticated Encryption][AEAD] with XChacha20 and Poly1305
+  (RFC&nbsp;8439).
+- [Hashing][HASH] with Blake2b.
+- [Password Hashing][PWH] with Argon2i.
+- [Public Key Cryptography][PKC] with X25519 (key exchange).
+- [Public Key Signatures][PKS] with EdDSA (RFC 8032) and Ed25519.
+- [Steganography support][STEG] with Elligator&nbsp;2.
+- [OPRF and PAKE support][PAKE] with Elligator&nbsp;2 and scalar
+  inversion.
+
+[AEAD]: https://monocypher.org/manual/aead
+[HASH]: https://monocypher.org/manual/hash
+[PWH]:  https://monocypher.org/manual/argon2i
+[PKC]:  https://monocypher.org/manual/key_exchange
+[PKS]:  https://monocypher.org/manual/sign
+[STEG]: https://monocypher.org/manual/advanced/elligator
+[PAKE]: https://monocypher.org/manual/advanced/x25519_inverse
+
+
 Manual
 ------