Add RPCs for running TCP forwarder on test runner

dlon · dlon · commit f30d6d16b2d9 · 2024-02-07T17:10:17.000+01:00
diff --git a/test/socks-server/src/lib.rs b/test/socks-server/src/lib.rs
@@ -3,12 +3,18 @@ use std::io;
 use std::net::SocketAddr;
 
 #[derive(err_derive::Error, Debug)]
+#[error(no_from)]
 pub enum Error {
     #[error(display = "Failed to start SOCKS5 server")]
     StartSocksServer(#[error(source)] io::Error),
 }
 
-pub async fn spawn(bind_addr: SocketAddr) -> Result<tokio::task::JoinHandle<()>, Error> {
+pub struct Handle {
+    handle: tokio::task::JoinHandle<()>,
+}
+
+/// Spawn a SOCKS server bound to `bind_addr`
+pub async fn spawn(bind_addr: SocketAddr) -> Result<Handle, Error> {
     let socks_server: fast_socks5::server::Socks5Server =
         fast_socks5::server::Socks5Server::bind(bind_addr)
             .await
@@ -21,6 +27,8 @@ pub async fn spawn(bind_addr: SocketAddr) -> Result<tokio::task::JoinHandle<()>,
             match new_client {
                 Ok(socket) => {
                     let fut = socket.upgrade_to_socks5();
+
+                    // Act as normal SOCKS server
                     tokio::spawn(async move {
                         match fut.await {
                             Ok(_socket) => log::info!("socks client disconnected"),
@@ -34,5 +42,17 @@ pub async fn spawn(bind_addr: SocketAddr) -> Result<tokio::task::JoinHandle<()>,
             }
         }
     });
-    Ok(handle)
+    Ok(Handle { handle })
+}
+
+impl Handle {
+    pub fn close(&self) {
+        self.handle.abort();
+    }
+}
+
+impl Drop for Handle {
+    fn drop(&mut self) {
+        self.close();
+    }
 }
diff --git a/test/test-manager/src/main.rs b/test/test-manager/src/main.rs
@@ -299,7 +299,7 @@ async fn main() -> Result<()> {
             if display {
                 instance.wait().await;
             }
-            socks.abort();
+            socks.close();
             result
         }
         Commands::FormatTestReports { reports } => {
diff --git a/test/test-rpc/src/client.rs b/test/test-rpc/src/client.rs
@@ -213,6 +213,16 @@ impl ServiceClient {
             .await?
     }
 
+    /// Start forwarding TCP from a server listening on `bind_addr` to the given address, and return a handle that closes the
+    /// server when dropped
+    pub async fn start_tcp_forward(
+        &self,
+        bind_addr: SocketAddr,
+        via_addr: SocketAddr,
+    ) -> Result<crate::net::SockHandle, Error> {
+        crate::net::SockHandle::start_tcp_forward(self.client.clone(), bind_addr, via_addr).await
+    }
+
     /// Restarts the app.
     ///
     /// Shuts down a running app, making it disconnect from any current tunnel
diff --git a/test/test-rpc/src/lib.rs b/test/test-rpc/src/lib.rs
@@ -53,6 +53,8 @@ pub enum Error {
     InvalidUrl,
     #[error(display = "Timeout")]
     Timeout,
+    #[error(display = "TCP forward error")]
+    TcpForward,
 }
 
 /// Response from am.i.mullvad.net
@@ -148,6 +150,16 @@ mod service {
         /// Perform DNS resolution.
         async fn resolve_hostname(hostname: String) -> Result<Vec<SocketAddr>, Error>;
 
+        /// Start forwarding TCP bound to the given address. Return an ID that can be used with
+        /// `stop_tcp_forward`, and the address that the listening socket was actually bound to.
+        async fn start_tcp_forward(
+            bind_addr: SocketAddr,
+            via_addr: SocketAddr,
+        ) -> Result<(net::SockHandleId, SocketAddr), Error>;
+
+        /// Stop forwarding TCP that was previously started with `start_tcp_forward`.
+        async fn stop_tcp_forward(id: net::SockHandleId) -> Result<(), Error>;
+
         /// Restart the Mullvad VPN application.
         async fn restart_mullvad_daemon() -> Result<(), Error>;
 
diff --git a/test/test-rpc/src/net.rs b/test/test-rpc/src/net.rs
@@ -1,6 +1,8 @@
+use futures::channel::oneshot;
 use hyper::{Client, Uri};
 use once_cell::sync::Lazy;
-use serde::de::DeserializeOwned;
+use serde::{de::DeserializeOwned, Deserialize, Serialize};
+use std::net::SocketAddr;
 use tokio_rustls::rustls::ClientConfig;
 
 use crate::{AmIMullvad, Error};
@@ -17,6 +19,59 @@ static CLIENT_CONFIG: Lazy<ClientConfig> = Lazy::new(|| {
         .with_no_client_auth()
 });
 
+#[derive(Debug, Serialize, Deserialize, Clone, Copy, Hash, PartialEq, Eq)]
+pub struct SockHandleId(pub usize);
+
+pub struct SockHandle {
+    stop_tx: Option<oneshot::Sender<()>>,
+    bind_addr: SocketAddr,
+}
+
+impl SockHandle {
+    pub(crate) async fn start_tcp_forward(
+        client: crate::service::ServiceClient,
+        bind_addr: SocketAddr,
+        via_addr: SocketAddr,
+    ) -> Result<Self, Error> {
+        let (stop_tx, stop_rx) = oneshot::channel();
+
+        let (id, bind_addr) = client
+            .start_tcp_forward(tarpc::context::current(), bind_addr, via_addr)
+            .await??;
+
+        tokio::spawn(async move {
+            let _ = stop_rx.await;
+
+            log::trace!("Stopping TCP forward");
+
+            if let Err(error) = client.stop_tcp_forward(tarpc::context::current(), id).await {
+                log::error!("Failed to stop TCP forward: {error}");
+            }
+        });
+
+        Ok(SockHandle {
+            stop_tx: Some(stop_tx),
+            bind_addr,
+        })
+    }
+
+    pub fn stop(&mut self) {
+        if let Some(stop_tx) = self.stop_tx.take() {
+            let _ = stop_tx.send(());
+        }
+    }
+
+    pub fn bind_addr(&self) -> SocketAddr {
+        self.bind_addr
+    }
+}
+
+impl Drop for SockHandle {
+    fn drop(&mut self) {
+        self.stop()
+    }
+}
+
 pub async fn geoip_lookup(mullvad_host: String) -> Result<AmIMullvad, Error> {
     let uri = Uri::try_from(format!("https://ipv4.am.i.{mullvad_host}/json"))
         .map_err(|_| Error::InvalidUrl)?;
diff --git a/test/test-runner/src/forward.rs b/test/test-runner/src/forward.rs
@@ -0,0 +1,127 @@
+use once_cell::sync::Lazy;
+use std::collections::HashMap;
+use std::net::SocketAddr;
+use std::sync::atomic::{AtomicUsize, Ordering};
+use std::sync::{Arc, Mutex};
+use test_rpc::net::SockHandleId;
+use tokio::net::TcpListener;
+use tokio::net::TcpStream;
+
+static SERVERS: Lazy<Mutex<HashMap<SockHandleId, Handle>>> =
+    Lazy::new(|| Mutex::new(HashMap::new()));
+
+/// Spawn a TCP forwarder that sends TCP via `via_addr`
+pub async fn start_server(
+    bind_addr: SocketAddr,
+    via_addr: SocketAddr,
+) -> Result<(SockHandleId, SocketAddr), test_rpc::Error> {
+    let next_nonce = {
+        static NONCE: AtomicUsize = AtomicUsize::new(0);
+        || NONCE.fetch_add(1, Ordering::Relaxed)
+    };
+    let id = SockHandleId(next_nonce());
+
+    let handle = tcp_forward(bind_addr, via_addr).await.map_err(|error| {
+        log::error!("Failed to start TCP forwarder listener: {error}");
+        test_rpc::Error::TcpForward
+    })?;
+
+    let bind_addr = handle.local_addr();
+
+    let mut servers = SERVERS.lock().unwrap();
+    servers.insert(id, handle);
+
+    Ok((id, bind_addr))
+}
+
+/// Stop TCP forwarder given some ID returned by `start_server`
+pub async fn stop_server(id: SockHandleId) -> Result<(), test_rpc::Error> {
+    let handle = {
+        let mut servers = SERVERS.lock().unwrap();
+        servers.remove(&id)
+    };
+
+    if let Some(handle) = handle {
+        handle.close();
+    }
+    Ok(())
+}
+
+struct Handle {
+    handle: tokio::task::JoinHandle<()>,
+    bind_addr: SocketAddr,
+    clients: Arc<Mutex<Vec<tokio::task::JoinHandle<()>>>>,
+}
+
+impl Handle {
+    pub fn close(&self) {
+        self.handle.abort();
+
+        let mut clients = self.clients.lock().unwrap();
+        for client in clients.drain(..) {
+            client.abort();
+        }
+    }
+
+    pub fn local_addr(&self) -> SocketAddr {
+        self.bind_addr
+    }
+}
+
+impl Drop for Handle {
+    fn drop(&mut self) {
+        self.close();
+    }
+}
+
+/// Forward TCP traffic via `proxy_addr`
+async fn tcp_forward(
+    bind_addr: SocketAddr,
+    proxy_addr: SocketAddr,
+) -> Result<Handle, test_rpc::Error> {
+    let listener = TcpListener::bind(&bind_addr).await.map_err(|error| {
+        log::error!("Failed to bind TCP forward socket: {error}");
+        test_rpc::Error::TcpForward
+    })?;
+    let bind_addr = listener.local_addr().map_err(|error| {
+        log::error!("Failed to get TCP socket addr: {error}");
+        test_rpc::Error::TcpForward
+    })?;
+
+    let clients = Arc::new(Mutex::new(vec![]));
+
+    let clients_copy = clients.clone();
+
+    let handle = tokio::spawn(async move {
+        loop {
+            match listener.accept().await {
+                Ok((mut client, _addr)) => {
+                    let client_handle = tokio::spawn(async move {
+                        let mut proxy = match TcpStream::connect(proxy_addr).await {
+                            Ok(proxy) => proxy,
+                            Err(error) => {
+                                log::error!("failed to connect to TCP proxy: {error}");
+                                return;
+                            }
+                        };
+
+                        if let Err(error) =
+                            tokio::io::copy_bidirectional(&mut client, &mut proxy).await
+                        {
+                            log::error!("copy_directional failed: {error}");
+                        }
+                    });
+                    clients_copy.lock().unwrap().push(client_handle);
+                }
+                Err(error) => {
+                    log::error!("failed to accept TCP client: {error}");
+                }
+            }
+        }
+    });
+    Ok(Handle {
+        handle,
+        bind_addr,
+        clients,
+    })
+}
diff --git a/test/test-runner/src/main.rs b/test/test-runner/src/main.rs
@@ -10,6 +10,7 @@ use tarpc::context;
 use tarpc::server::Channel;
 use test_rpc::{
     mullvad_daemon::{ServiceStatus, SOCKET_PATH},
+    net::SockHandleId,
     package::Package,
     transport::GrpcForwarder,
     AppTrace, Service,
@@ -22,6 +23,7 @@ use tokio::{
 use tokio_util::codec::{Decoder, LengthDelimitedCodec};
 
 mod app;
+mod forward;
 mod logging;
 mod net;
 mod package;
@@ -167,6 +169,23 @@ impl Service for TestServer {
             .collect())
     }
 
+    async fn start_tcp_forward(
+        self,
+        _: context::Context,
+        bind_addr: SocketAddr,
+        via_addr: SocketAddr,
+    ) -> Result<(SockHandleId, SocketAddr), test_rpc::Error> {
+        forward::start_server(bind_addr, via_addr).await
+    }
+
+    async fn stop_tcp_forward(
+        self,
+        _: context::Context,
+        id: SockHandleId,
+    ) -> Result<(), test_rpc::Error> {
+        forward::stop_server(id).await
+    }
+
     async fn get_interface_ip(
         self,
         _: context::Context,

Original file line number	Diff line number	Diff line change
`@@ -299,7 +299,7 @@ async fn main() -> Result<()> {`
`299`	`299`	`if display {`
`300`	`300`	`instance.wait().await;`
`301`	`301`	`}`
`302`		`- socks.abort();`
	`302`	`+ socks.close();`
`303`	`303`	`result`
`304`	`304`	`}`
`305`	`305`	`Commands::FormatTestReports { reports } => {`