Merge pull request #9191 from holtrop/rust-wrapper

Create initial Rust wrapper structure

Author: JacobBarthelmeh

.github/workflows/rust-wrapper.yml

@@ -0,0 +1,30 @@
+name: Build Rust Wrapper
+
+# START OF COMMON SECTION
+on:
+  push:
+    branches: [ 'master', 'main', 'release/**' ]
+  pull_request:
+    branches: [ '*' ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+# END OF COMMON SECTION
+
+jobs:
+  build_wolfssl:
+    name: Build wolfSSL Rust Wrapper
+    if: github.repository_owner == 'wolfssl'
+    runs-on: ubuntu-24.04
+    # This should be a safe limit for the tests to run.
+    timeout-minutes: 10
+    steps:
+    - name: Build wolfSSL
+      uses: wolfSSL/actions-build-autotools-project@v1
+      with:
+        path: wolfssl
+        configure: --enable-all
+    - name: Build Rust Wrapper
+      working-directory: wolfssl
+      run: make -C wrapper/rust

.gitignore

@@ -33,7 +33,7 @@ aclocal.m4
 aminclude.am
 lt*.m4
 Makefile.in
-Makefile
+/Makefile
 depcomp
 missing
 libtool
@@ -458,6 +458,9 @@ wrapper/Ada/config/
 wrapper/Ada/lib/
 wrapper/Ada/obj/
 
+# Rust wrapper files
+/wrapper/rust/*/target/
+
 # PlatformIO
 /**/.pio
 /**/.vscode/.browse.c_cpp.db*

wrapper/include.am

@@ -4,5 +4,6 @@
 
 include wrapper/Ada/include.am
 include wrapper/CSharp/include.am
+include wrapper/rust/include.am
 
 EXTRA_DIST+= wrapper/python/README.md

wrapper/rust/Makefile

@@ -0,0 +1,9 @@
+.PHONY: all
+all:
+	+$(MAKE) -C wolfssl-sys
+	+$(MAKE) -C wolfssl
+
+.PHONY: clean
+clean:
+	+$(MAKE) -C wolfssl-sys clean
+	+$(MAKE) -C wolfssl clean

wrapper/rust/README.md

@@ -0,0 +1,17 @@
+# wolfSSL Rust Wrapper
+
+## Building the wolfssl Rust Wrapper
+
+First, configure and build wolfssl C library.
+
+Then build the wolfssl Rust wrapper with:
+
+    make -C wrapper/rust
+
+## Repository Directory Structure
+
+| Repository Directory | Description |
+| --- | --- |
+| `/wrapper/rust` | Top level container for all Rust wrapper functionality. |
+| `/wrapper/rust/wolfssl` | Top level for the `wolfssl` library crate. This crate contains high-level Rust sources that use the bindings from the `wolfssl-sys` crate. |
+| `/wrapper/rust/wolfssl-sys` | Top level for the `wolfssl-sys` library crate. This crate contains only automatically generated bindings to the `wolfssl` C library. |

wrapper/rust/include.am

@@ -0,0 +1,16 @@
+# vim:ft=automake
+# included from Top Level Makefile.am
+# All paths should be given relative to the root
+
+EXTRA_DIST += wrapper/rust/Makefile
+EXTRA_DIST += wrapper/rust/README.md
+EXTRA_DIST += wrapper/rust/wolfssl-sys/Cargo.lock
+EXTRA_DIST += wrapper/rust/wolfssl-sys/Cargo.toml
+EXTRA_DIST += wrapper/rust/wolfssl-sys/Makefile
+EXTRA_DIST += wrapper/rust/wolfssl-sys/build.rs
+EXTRA_DIST += wrapper/rust/wolfssl-sys/headers.h
+EXTRA_DIST += wrapper/rust/wolfssl-sys/src/lib.rs
+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/src/lib.rs