tests: test against bitbox02 simulators

The simulators are downloaded base on the simulators.json file if the
file does not exist (or the hash is wrong).

This allows us to exercise the library much more easily without
needing to mock everything, as the simulator behaves like the real
BitBox02 for the most part.

We could automatically download all releases by using the GitHub
releases
API (https://api.github.com/repos/BitBoxSwiss/bitbox02-firmware/releases),
but the downside is that there would be network requests each time you
run the unit tests. For now we simply keep the list manually.

The simulators are only released for linux-amd64 for now, so we skip
tests if we are not running in this environment.

Author: benma

Cargo.lock

@@ -43,7 +43,12 @@ wasm-bindgen-futures = { version ="0.4.42", optional = true }
 web-sys = { version = "0.3.64", features = ["Storage", "Window"], optional = true }
 
 [dev-dependencies]
+async-trait = "0.1.68"
 wasm-bindgen-test = "0.3.42"
+tokio = { version = "1", features = ["time", "macros", "rt", "fs"] }
+reqwest = "0.12"
+url = "2.5"
+bitcoinconsensus = { version = "0.106.0", default-features = false }
 
 [build-dependencies]
 prost-build = { version = "0.11" }
@@ -91,6 +96,7 @@ lto = true
 # This may or may not cause trouble on macOS, see: https://github.com/libusb/hidapi/issues/503
 multithreaded = []
 usb = ["dep:hidapi"]
+simulator = []
 wasm = [
   "dep:enum-assoc",
   "dep:js-sys",

Cargo.toml

@@ -1,4 +1,4 @@
-Copyright 2023 Shift Crypto AG, Switzerland. All rights reserved.
+Copyright 2023-2024 Shift Crypto AG, Switzerland. All rights reserved.
 
                                  Apache License
                            Version 2.0, January 2004

LICENSE

@@ -3,6 +3,7 @@
 set -e
 
 features=(
+  "simulator,tokio"
   "usb"
   "wasm"
   "multithreaded,usb"
@@ -23,8 +24,8 @@ cargo fmt --check
 
 for feature_set in "${features[@]}"; do
   echo $feature_set
-  cargo test --locked --features="$feature_set" --all-targets
-  cargo clippy --locked --features="$feature_set" --all-targets -- -D warnings -A clippy::empty-docs
+  cargo test --tests --locked --features="$feature_set" -- --nocapture
+  cargo clippy --tests --locked --features="$feature_set" -- -D warnings -A clippy::empty-docs
 done
 
 for example in "${examples[@]}"; do

ci.sh

@@ -4,7 +4,7 @@ use crate::util::Threading;
 use async_trait::async_trait;
 use thiserror::Error;
 
-#[cfg(any(feature = "wasm", feature = "usb"))]
+#[cfg(any(feature = "wasm", feature = "usb", feature = "simulator"))]
 pub const FIRMWARE_CMD: u8 = 0x80 + 0x40 + 0x01;
 
 #[derive(Error, Debug)]
@@ -146,7 +146,7 @@ const HWW_RSP_BUSY: u8 = 0x02;
 // Bad request.
 const HWW_RSP_NACK: u8 = 0x03;
 
-#[derive(Debug, Copy, Clone)]
+#[derive(PartialEq, Debug, Copy, Clone)]
 pub enum Product {
     Unknown,
     BitBox02Multi,

src/communication.rs

@@ -1,2 +1,4 @@
+#[cfg(any(feature = "wasm", feature = "usb"))]
 pub const VENDOR_ID: u16 = 0x03eb;
+#[cfg(any(feature = "wasm", feature = "usb"))]
 pub const PRODUCT_ID: u16 = 0x2403;

src/constants.rs

@@ -52,6 +52,9 @@ pub enum Error {
     #[cfg(feature = "usb")]
     #[error("hid error: {0}")]
     Hid(#[from] hidapi::HidError),
+    #[cfg(feature = "simulator")]
+    #[error("simulator error: {0}")]
+    Simulator(#[from] crate::simulator::Error),
     #[error("communication error: {0}")]
     #[cfg_attr(feature = "wasm", assoc(js_code = "communication".into()))]
     Communication(communication::Error),

src/error.rs

@@ -9,6 +9,8 @@ pub mod error;
 pub mod eth;
 mod noise;
 pub mod runtime;
+#[cfg(feature = "simulator")]
+pub mod simulator;
 #[cfg(feature = "usb")]
 pub mod usb;
 #[cfg(feature = "wasm")]
@@ -97,6 +99,18 @@ impl<R: Runtime> BitBox<R> {
         Self::from(comm, noise_config).await
     }
 
+    #[cfg(feature = "simulator")]
+    pub async fn from_simulator(
+        endpoint: Option<&str>,
+        noise_config: Box<dyn NoiseConfig>,
+    ) -> Result<BitBox<R>, Error> {
+        let comm = Box::new(communication::U2fHidCommunication::from(
+            crate::simulator::try_connect::<R>(endpoint).await?,
+            communication::FIRMWARE_CMD,
+        ));
+        Self::from(comm, noise_config).await
+    }
+
     /// Invokes the device unlock and pairing.
     pub async fn unlock_and_pair(self) -> Result<PairingBitBox<R>, Error> {
         self.communication

src/lib.rs

@@ -0,0 +1,62 @@
+use async_trait::async_trait;
+use std::io::{Read, Write};
+use std::net::TcpStream;
+
+use std::sync::Mutex;
+
+use super::communication::{Error as CommunicationError, ReadWrite};
+use super::runtime::Runtime;
+
+const DEFAULT_ENDPOINT: &str = "127.0.0.1:15423";
+
+pub struct TcpClient {
+    stream: Mutex<TcpStream>,
+}
+
+impl TcpClient {
+    fn new(address: &str) -> Result<Self, std::io::Error> {
+        let stream = TcpStream::connect(address)?;
+        Ok(Self {
+            stream: Mutex::new(stream),
+        })
+    }
+}
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    #[error("connection error")]
+    Connect,
+}
+
+/// Connect to a running simulator at this endpoint. Endpoint defaults to `127.0.0.1:15423`.
+/// This tries to connect repeatedly for up to about 2 seconds.
+pub async fn try_connect<R: Runtime>(endpoint: Option<&str>) -> Result<Box<TcpClient>, Error> {
+    for _ in 0..200 {
+        match TcpClient::new(endpoint.unwrap_or(DEFAULT_ENDPOINT)) {
+            Ok(client) => return Ok(Box::new(client)),
+            Err(_) => R::sleep(std::time::Duration::from_millis(10)).await,
+        }
+    }
+    Err(Error::Connect)
+}
+
+impl crate::util::Threading for TcpClient {}
+
+#[async_trait(?Send)]
+impl ReadWrite for TcpClient {
+    fn write(&self, msg: &[u8]) -> Result<usize, CommunicationError> {
+        let mut stream = self.stream.lock().unwrap();
+        stream.write(msg).map_err(|_| CommunicationError::Write)
+    }
+
+    async fn read(&self) -> Result<Vec<u8>, CommunicationError> {
+        let mut stream = self.stream.lock().unwrap();
+
+        let mut buffer = vec![0; 64];
+        let n = stream
+            .read(&mut buffer)
+            .map_err(|_| CommunicationError::Read)?;
+        buffer.truncate(n);
+        Ok(buffer)
+    }
+}

src/simulator.rs

@@ -0,0 +1 @@
+/simulators/