rust: enable bindings to be built without existing cmake build dir

Author: NickeZ

.gitattributes

@@ -1 +1,2 @@
-/py/bitbox02/bitbox02/generated/* linguist-generated=true
+/py/bitbox02/bitbox02/generated/ linguist-generated=true
+/src/rust/vendor/ linguist-generated=true

src/CMakeLists.txt

@@ -306,6 +306,14 @@ add_custom_target(rust-bindgen
   )
 add_dependencies(rust-bindgen generate-protobufs)
 
+# A custom target to export the list of includes for rust tooling (RA, clippy)
+add_custom_command(OUTPUT rust-bindgen.flags
+  COMMAND
+    ${CMAKE_COMMAND} -E echo ${RUST_INCLUDES} > rust-bindgen.flags
+)
+add_custom_target(rust-bindgen-includes DEPENDS rust-bindgen.flags)
+add_dependencies(rust-bindgen-includes generate-protobufs)
+
 
 # Test rust crates that contain business logic. Avoid testing crates that depend on hardware.
 if(NOT CMAKE_CROSSCOMPILING)

src/rust/Cargo.lock

@@ -35,3 +35,9 @@ The bottom-most layer are bindings generated from C header files:
 
 We generate one header file `rust.h` and ever product specific function is `#ifdeffed` with
 `RUST_PRODUCT_*` macro.
+
+
+# rust-analyzer / clippy
+
+To be able to run static analyzers you'll need nanopb to work and libclang to be available on the
+host machine.

src/rust/README.md

@@ -22,3 +22,6 @@ license = "Apache-2.0"
 
 [dependencies]
 util = {path = "../util"}
+
+[build-dependencies]
+tempdir = "0.3"

src/rust/bitbox02-sys/Cargo.toml

@@ -0,0 +1,40 @@
+use std::process::Command;
+use std::fs::File;
+use std::io::prelude::*;
+use tempdir::TempDir;
+
+fn main() {
+    let path_to_bindings = if let Ok(cmake_dir) = std::env::var("CMAKE_CURRENT_BINARY_DIR") {
+        // if we are being invoked from CMAKE, the bindings are here:
+        format!("{}/rust", cmake_dir)
+    } else {
+        let bitbox02_sys_dir = std::env::var("CARGO_MANIFEST_DIR").unwrap();
+        let cmake_dir = format!("{}/../../../", bitbox02_sys_dir);
+
+        // generate list of includes using CMake
+        let tempdir = TempDir::new("bitbox02").unwrap();
+        let tempdir = tempdir.as_ref().to_str().unwrap();
+        let _ = Command::new("cmake").arg(&cmake_dir).current_dir(&tempdir).output().unwrap();
+        let _ = Command::new("make").arg("rust-bindgen-includes").current_dir(&tempdir).output().unwrap();
+        let mut includes_file = File::open(format!("{}/src/rust-bindgen.flags", tempdir)).unwrap();
+        let mut includes = String::new();
+        includes_file.read_to_string(&mut includes).unwrap();
+        let includes:Vec<&str> = includes.trim().split_ascii_whitespace().collect();
+        let mut flags = vec!["-target", "x86_64-pc-linux-gnu", "-DTESTING=1"];
+        flags.extend(&includes);
+
+        // generate bindings
+        let outdir = std::env::var("OUT_DIR").unwrap();
+        let generate_bindings = format!("{}/scripts/generate-bindings.sh", cmake_dir);
+        let bindings = format!("{}/bindings.rs", outdir);
+        let wrapper = format!("{}/wrapper.h", bitbox02_sys_dir);
+        let _ = Command::new(&generate_bindings)
+            .args(&[&bindings, &wrapper])
+            .args(&flags)
+            .output()
+            .unwrap();
+
+        outdir
+    };
+    println!("cargo:rustc-env=BINDINGS={}/bindings.rs", path_to_bindings);
+}

src/rust/bitbox02-sys/build.rs

@@ -17,10 +17,7 @@
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
+#![allow(clippy::all)]
 
 // include our generated bindings
-include!(concat!(
-    env!("CMAKE_CURRENT_BINARY_DIR"),
-    "/rust",
-    "/bindings.rs"
-));
+include!(env!("BINDINGS"));

src/rust/bitbox02-sys/src/lib.rs

@@ -1,24 +1,26 @@
 fn main() {
     #[cfg(feature = "testing")]
     {
-        let cmake_dir = std::env::var("CMAKE_CURRENT_BINARY_DIR").unwrap();
-        println!("cargo:rustc-link-search={}/../lib", cmake_dir);
-        // c and rust code merged :O
-        println!("cargo:rustc-link-lib=bitbox_merged");
-        println!(
-            "cargo:rerun-if-changed={}/../lib/libbitbox_merged.a",
-            cmake_dir
-        );
+        // CMAKE_CURRENT_BINARY_DIR is required for building tests
+        if let Ok(cmake_dir) = std::env::var("CMAKE_CURRENT_BINARY_DIR") {
+            println!("cargo:rustc-link-search={}/../lib", cmake_dir);
+            // c and rust code merged :O
+            println!("cargo:rustc-link-lib=bitbox_merged");
+            println!(
+                "cargo:rerun-if-changed={}/../lib/libbitbox_merged.a",
+                cmake_dir
+            );
 
-        // external libs
-        println!("cargo:rustc-link-lib=wallycore");
-        println!("cargo:rustc-link-lib=secp256k1");
-        println!("cargo:rustc-link-lib=base32");
-        println!("cargo:rustc-link-lib=ctaes");
-        println!("cargo:rustc-link-lib=fatfs");
-        println!("cargo:rustc-link-lib=sd-mock");
+            // external libs
+            println!("cargo:rustc-link-lib=wallycore");
+            println!("cargo:rustc-link-lib=secp256k1");
+            println!("cargo:rustc-link-lib=base32");
+            println!("cargo:rustc-link-lib=ctaes");
+            println!("cargo:rustc-link-lib=fatfs");
+            println!("cargo:rustc-link-lib=sd-mock");
 
-        // system libs
-        println!("cargo:rustc-link-lib=cmocka");
+            // system libs
+            println!("cargo:rustc-link-lib=cmocka");
+        }
     }
 }

src/rust/bitbox02/build.rs

@@ -0,0 +1 @@
+{"files":{"AUTHORS":"f82920a5bcfc71b86c1de4be4cdea8af2009ba9e5735824f95ed5043a03e46f0","Cargo.toml":"bb2497b2907c3af499ce7ac3722dae044968e13409a372b7760150f8a01c74c5","LICENSE":"03b114f53e6587a398931762ee11e2395bfdba252a329940e2c8c9e81813845b","PATENTS":"52beb3ac72a0e7f5060384d16e4e6f91573016448fbff363c0b01a66fe99f547","src/lib.rs":"3d76c35c13203093ddf7ce2a3be5e98d768a8091cd9d99bd083fe8db35364096"},"package":"a06f77d526c1a601b7c4cdd98f54b5eaabffc14d5f2f0296febdc7f357c6d3ba"}

src/rust/vendor/fuchsia-cprng/.cargo-checksum.json

@@ -0,0 +1,10 @@
+# This is the list of Fuchsia Authors.
+
+# Names should be added to this file as one of
+#     Organization's name
+#     Individual's name <submission email address>
+#     Individual's name <submission email address> <email2> <emailN>
+
+Google Inc.
+The Chromium Authors
+The Go Authors

src/rust/vendor/fuchsia-cprng/AUTHORS

@@ -0,0 +1,22 @@
+# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
+#
+# When uploading crates to the registry Cargo will automatically
+# "normalize" Cargo.toml files for maximal compatibility
+# with all versions of Cargo and also rewrite `path` dependencies
+# to registry (e.g. crates.io) dependencies
+#
+# If you believe there's an error in this file please file an
+# issue against the rust-lang/cargo repository. If you're
+# editing this file be aware that the upstream Cargo.toml
+# will likely look very different (and much more reasonable)
+
+[package]
+edition = "2018"
+name = "fuchsia-cprng"
+version = "0.1.1"
+authors = ["Erick Tryzelaar <[email protected]>"]
+include = ["src/*.rs", "Cargo.toml", "AUTHORS", "LICENSE", "PATENTS"]
+description = "Rust crate for the Fuchsia cryptographically secure pseudorandom number generator"
+readme = "README.md"
+license-file = "LICENSE"
+repository = "https://fuchsia.googlesource.com/fuchsia/+/master/garnet/public/rust/fuchsia-cprng"

src/rust/vendor/fuchsia-cprng/Cargo.toml

@@ -0,0 +1,27 @@
+Copyright 2019 The Fuchsia Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/rust/vendor/fuchsia-cprng/LICENSE

@@ -0,0 +1,22 @@
+Additional IP Rights Grant (Patents)
+
+"This implementation" means the copyrightable works distributed by
+Google as part of the Fuchsia project.
+
+Google hereby grants to you a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this
+section) patent license to make, have made, use, offer to sell, sell,
+import, transfer, and otherwise run, modify and propagate the contents
+of this implementation of Fuchsia, where such license applies only to
+those patent claims, both currently owned by Google and acquired in
+the future, licensable by Google that are necessarily infringed by
+this implementation. This grant does not include claims that would be
+infringed only as a consequence of further modification of this
+implementation. If you or your agent or exclusive licensee institute
+or order or agree to the institution of patent litigation or any other
+patent enforcement activity against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that this
+implementation of Fuchsia constitutes direct or contributory patent
+infringement, or inducement of patent infringement, then any patent
+rights granted to you under this License for this implementation of
+Fuchsia shall terminate as of the date such litigation is filed.