Merge pull request #9542 from holtrop-wolfssl/rust-wolfssl-wolfcrypt-crate

Create wolfssl-wolfcrypt Rust crate

Author: JacobBarthelmeh

wrapper/rust/Makefile

@@ -1,11 +1,11 @@
 .PHONY: all
 all:
-	+$(MAKE) -C wolfssl
+	+$(MAKE) -C wolfssl-wolfcrypt
 
 .PHONY: test
 test:
-	+$(MAKE) -C wolfssl test
+	+$(MAKE) -C wolfssl-wolfcrypt test
 
 .PHONY: clean
 clean:
-	+$(MAKE) -C wolfssl clean
+	+$(MAKE) -C wolfssl-wolfcrypt clean

wrapper/rust/README.md

@@ -1,6 +1,11 @@
 # wolfSSL Rust Wrapper
 
-## Building the wolfssl Rust Wrapper
+The wolfSSL Rust wrapper currently consists of a single Rust crate named
+`wolfssl-wolfcrypt`.
+The `wolfssl-wolfcrypt` crate is a Rust wrapper for the wolfCrypt cryptographic
+algorithms portion of the wolfSSL C library.
+
+## Locally building and testing the wolfSSL Rust Wrapper
 
 First, configure and build wolfssl C library.
 
@@ -17,32 +22,5 @@ Run tests with:
 | Repository Directory | Description |
 | --- | --- |
 | `/wrapper/rust` | Top level container for all Rust wrapper functionality. |
-| `/wrapper/rust/wolfssl` | Top level for the `wolfssl` library crate. |
-| `/wrapper/rust/wolfssl/src` | Source directory for `wolfssl` crate top-level modules. |
-| `/wrapper/rust/wolfssl/src/wolfcrypt` | Source directory for submodules of `wolfssl::wolfcrypt` module. |
-
-## API Coverage
-
-The wolfSSL Rust wrapper provides a wrapper API for the following 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
+| `/wrapper/rust/wolfssl-wolfcrypt` | Top level for the `wolfssl-wolfcrypt` library crate. |
+| `/wrapper/rust/wolfssl-wolfcrypt/src` | Source directory for `wolfssl-wolfcrypt` crate top-level modules. |

wrapper/rust/include.am

@@ -4,36 +4,38 @@
 
 EXTRA_DIST += wrapper/rust/Makefile
 EXTRA_DIST += wrapper/rust/README.md
-EXTRA_DIST += wrapper/rust/wolfssl/Cargo.lock
-EXTRA_DIST += wrapper/rust/wolfssl/Cargo.toml
-EXTRA_DIST += wrapper/rust/wolfssl/Makefile
-EXTRA_DIST += wrapper/rust/wolfssl/build.rs
-EXTRA_DIST += wrapper/rust/wolfssl/headers.h
-EXTRA_DIST += wrapper/rust/wolfssl/src/lib.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/aes.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/cmac.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/dh.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/ecc.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/ed25519.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/ed448.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/hkdf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/hmac.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/kdf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/prf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/random.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/rsa.rs
-EXTRA_DIST += wrapper/rust/wolfssl/src/wolfcrypt/sha.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_aes.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_cmac.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_dh.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_ecc.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_ed25519.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_ed448.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_hkdf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_hmac.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_kdf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_prf.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_random.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_rsa.rs
-EXTRA_DIST += wrapper/rust/wolfssl/tests/test_sha.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/Cargo.lock
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/Cargo.toml
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/Makefile
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/README.md
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/build.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/headers.h
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/aes.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/cmac.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/dh.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/ecc.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/ed25519.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/ed448.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/hkdf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/hmac.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/kdf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/lib.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/prf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/random.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/rsa.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/sha.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/src/sys.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_aes.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_cmac.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_dh.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_ecc.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_ed25519.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_ed448.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_hkdf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_hmac.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_kdf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_prf.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_random.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_rsa.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_sha.rs
+EXTRA_DIST += wrapper/rust/wolfssl-wolfcrypt/tests/test_wolfcrypt.rs

wrapper/rust/wolfssl-wolfcrypt/CHANGELOG.md

@@ -0,0 +1,13 @@
+# wolfssl-wolfcrypt Change Log
+
+## v1.0.0
+
+- Bump version to 1.0 after testing
+
+## v0.1.1
+
+- Only set link-search and link-arg for local repo build
+
+## v0.1.0
+
+- Initial test version

wrapper/rust/wolfssl/Cargo.lock wrapper/rust/wolfssl-wolfcrypt/Cargo.lockwrapper/rust/wolfssl/Cargo.lock renamed to wrapper/rust/wolfssl-wolfcrypt/Cargo.lock

@@ -1,13 +1,14 @@
 [package]
-name = "wolfssl"
-version = "0.1.0"
+name = "wolfssl-wolfcrypt"
+version = "1.0.0"
 edition = "2024"
-description = "Rust wrapper for wolfssl C library"
+description = "Rust wrapper for wolfssl C library cryptographic functionality"
 license = "GPL-3.0"
 repository = "https://github.com/wolfSSL/wolfssl"
 documentation = "https://github.com/wolfSSL/wolfssl/tree/master/wrapper/rust"
 keywords = ["wolfssl", "fips", "security", "encryption", "cryptography"]
 categories = ["cryptography", "security", "api-bindings"]
+readme = "README.md"
 
 [features]
 std = []

wrapper/rust/wolfssl/Cargo.toml wrapper/rust/wolfssl-wolfcrypt/Cargo.tomlwrapper/rust/wolfssl/Cargo.toml renamed to wrapper/rust/wolfssl-wolfcrypt/Cargo.toml

@@ -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

wrapper/rust/wolfssl/Makefile wrapper/rust/wolfssl-wolfcrypt/Makefilewrapper/rust/wolfssl/Makefile renamed to wrapper/rust/wolfssl-wolfcrypt/Makefile

@@ -4,7 +4,7 @@ use regex::Regex;
 use std::env;
 use std::fs;
 use std::io::{self, Read, Result};
-use std::path::PathBuf;
+use std::path::{Path,PathBuf};
 
 /// Perform crate build.
 fn main() {
@@ -69,12 +69,19 @@ fn generate_bindings() -> Result<()> {
 /// Returns `Ok(())` if successful, or an error if any step fails.
 fn setup_wolfssl_link() -> Result<()> {
     println!("cargo:rustc-link-lib=wolfssl");
-    println!("cargo:rustc-link-search={}", wolfssl_lib_dir()?);
-    println!("cargo:rustc-link-arg=-Wl,-rpath,{}", wolfssl_lib_dir()?);
 
 //    TODO: do we need this if only a static library is built?
 //    println!("cargo:rustc-link-lib=static=wolfssl");
 
+    let build_in_repo = Path::new(&wolfssl_lib_dir()?).exists();
+    if build_in_repo {
+        // When the crate is built in the wolfssl repository, link with the
+        // locally build wolfssl library to allow testing any local changes
+        // and running unit tests even if library is not installed.
+        println!("cargo:rustc-link-search={}", wolfssl_lib_dir()?);
+        println!("cargo:rustc-link-arg=-Wl,-rpath,{}", wolfssl_lib_dir()?);
+    }
+
     Ok(())
 }