Add README.md in wolfssl-wolfcrypt crate directory

2026-05-05 06:24:13 +02:00 · 2025-12-15 15:22:44 -05:00
parent 0a469d4a4d
commit 447ba11379
3 changed files with 49 additions and 36 deletions
@@ -0,0 +1,44 @@
+# wolfssl-wolfcrypt crate
+
+The `wolfssl-wolfcrypt` crate is a Rust wrapper for the wolfCrypt cryptographic
+algorithms portion of the wolfSSL C library.
+
+## Installation
+
+The `wolfssl` C library must be installed to be used by the Rust crate.
+
+The `wolfssl-wolfcrypt` crate can be used by including it as a dependency in
+your project's `Cargo.toml` file.
+
+For example:
+
+```
+[dependencies]
+wolfssl-wolfcrypt = "1.0"
+```
+
+## API Coverage
+
+This crate provides a wrapper API for the following wolfCrypt C library
+functionality:
+
+  * AES
+    * CBC, CCM, CFB, CTR, EAX, ECB, GCM, OFB, XTS
+  * CMAC
+  * DH
+  * ECC
+  * Ed448
+  * Ed25519
+  * HKDF
+  * HMAC
+  * PBKDF2
+  * PKCS #12 PBKDF
+  * PRF
+  * RSA
+  * RNG
+  * SHA
+    * SHA-1, SHA-224, SHA-256, SHA-384, SHA-512, SHA3-224, SHA3-256, SHA3-384,
+      SHA3-512, SHAKE128, SHAKE256
+  * SRTP/SRTCP KDF
+  * SSH KDF
+  * TLSv1.3 HKDF