summaryrefslogtreecommitdiffstats
path: root/openpgp/README.md
diff options
context:
space:
mode:
authorNikhil Benesch <nikhil.benesch@gmail.com>2020-12-10 20:46:58 -0500
committerJustus Winter <justus@sequoia-pgp.org>2021-10-05 11:46:38 +0200
commit341fdd29a9863e793c560e2a7207989c4f61d772 (patch)
tree38ffda8be4d3ebce675e6561a3a619882934495e /openpgp/README.md
parentaa21e2404d9502eeea84ff39da03a85c971ea2d3 (diff)
openpgp: Add a RustCrypto backend.
- This adds a cryptographic backend based on the RustCrypto crates. The backend is marked as experimental, as the RustCrypto crates' authors state that they have not been audited and may not perform computations in constant time. Nevertheless, it may be useful in certain environments, e.g. WebAssembly. - The backend implements RSA, EdDSA and ECDH over Curve25519, IDEA, 3DES, CAST5, Blowfish, AES, Twofish, EAX, MD5, SHA1, RipeMD160, and the SHA2 family. - Notably missing are DSA, ElGamal, and ECDSA and ECDH over the NIST curves. - See #333.
Diffstat (limited to 'openpgp/README.md')
-rw-r--r--openpgp/README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/openpgp/README.md b/openpgp/README.md
index 3e0c81c2..c4bfa9e8 100644
--- a/openpgp/README.md
+++ b/openpgp/README.md
@@ -81,6 +81,13 @@ at compile time. Currently, these libraries are available:
include the `crypto-cng` feature to enable it. Currently, the CNG
backend requires at least Windows 10.
+ - The RustCrypto crates. To select this backend, use
+ `default-features = false`, and explicitly include the
+ `crypto-rust` feature to enable it. As of this writing, the
+ RustCrypto crates are not recommended for general use as they
+ cannot offer the same security guarantees as more mature
+ cryptographic libraries.
+
### Experimental and variable-time cryptographic backends
Some cryptographic backends are not yet considered mature enough for