aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJack Lloyd <[email protected]>2013-03-12 19:34:14 +0100
committerJack Lloyd <[email protected]>2013-03-12 19:34:14 +0100
commitfb9cce31fb5c53dd3f3f9c853d2e110c87c3834d (patch)
tree978b16eeb59add6f0eb32c8d50275a00b327367c /README.md
parentTake hash test inputs as hex strings. Add MD5 tests. (diff)
downloadrust-openssl-fb9cce31fb5c53dd3f3f9c853d2e110c87c3834d.tar.xz
rust-openssl-fb9cce31fb5c53dd3f3f9c853d2e110c87c3834d.zip
Add CTR and GCM support
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 8 insertions, 17 deletions
diff --git a/README.md b/README.md
index 4554176d..16740d5b 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,13 @@
This package provides Rust bindings for the functionality exposed by OpenSSL's
-libcrypto. Currently provided:
+libcrypto. OpenSSL 1.0.1 or higher is required. Currently provided:
-* Hashes (hash.rs)
- * MD5
+* Hash functions (hash.rs)
+ * SHA-512, SHA-384, SHA-256, SHA-224
* SHA-1
- * SHA-2 (224, 256, 384, 512)
+ * MD5
* Symmetric crypto (symm.rs)
- * AES-128 or AES-256 in ECB or CBC mode
+ * AES-128 and AES-256 (ECB, CBC, CTR or GCM mode)
* RC4-128
-* Keypair generation (pkey.rs)
- * RSA, all key lengths
-* Asymmetric encryption (pkey.rs)
- * RSA with PKCS #1 OAEP padding or PKCS #1 v1.5 padding
-* Digital signatures (pkey.rs)
- * RSA with PKCS #1 v1.5 padding and any supported hash
-
-Each module provides two interfaces: a low-level API which wraps the OpenSSL
-interfaces as directly as possible and a high-level API which presents the
-OpenSSL API as a Rust object and tries to make sensible default choices about
-parameters most users won't care about. You probably want to use the high-level
-API. For documentation on these, see the individual source files.
+* RSA (pkey.rs)
+ * Encryption with PKCS #1 OAEP padding or PKCS #1 v1.5 padding
+ * Signatures with PKCS #1 v1.5 padding and any supported hash