aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorElly Jones <[email protected]>2011-12-15 09:46:13 -0500
committerElly Jones <[email protected]>2011-12-15 10:04:00 -0500
commit62c421d5f66fe161b3c6b5b44968f01bf2459829 (patch)
treed3355362aa8e10ee0230a82408d4b73d957f4512 /README.md
downloadrust-openssl-62c421d5f66fe161b3c6b5b44968f01bf2459829.tar.xz
rust-openssl-62c421d5f66fe161b3c6b5b44968f01bf2459829.zip
Initial commit.
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..774949f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+This package provides Rust bindings for the functionality exposed by OpenSSL's
+libcrypto. Currently provided:
+
+* Hashes (hash.rs)
+ * MD5
+ * SHA-1
+ * SHA-2 (224, 256, 384, 512)
+* Symmetric crypto (symm.rs)
+ * AES in ECB or CBC mode, all key lengths
+* Keypair generation (pkey.rs)
+ * RSA, all key lengths
+* Asymmetric encryption (pkey.rs)
+ * RSA with PKCS#1 OAEP padding
+* Digital signatures (pkey.rs)
+ * RSA with whatever your system openssl does (PKCS#1 on my system) and sha256
+
+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.