Restructure and add library target (#394)

* move config (clap) structs into config.rs

- copied all config structs into config.rs, along with all `use`
statements
- made everything `pub`
- changed main.rs to import these structs

* remove unused imports and move parsing tests to config.rs

* cargo fmt

* separate library and cli

- make root package a cargo workspace
- move code to start client/server tunnels into lib.rs
- move rest of main.rs into wstunnel-cli bin package
- move "Wstunnel" config struct into bin package
  - the fields here are only applicable to the CLI

* cargo fmt

* move clap parsing into feature

* move argument parsing functions under clap feature

* update wstunnel-cli binary name and build workflow

* cargo fmt, fix tests

* update build instructions

* only use required tokio features

Author: grimsteel

.github/workflows/release.yaml

@@ -137,7 +137,7 @@ jobs:
         with:
           command: build
           use-cross: ${{ !contains(matrix.platform.target, 'x86_64') || contains(matrix.platform.target, 'freebsd') }}
-          args: ${{ matrix.platform.build-args }} --target ${{ matrix.platform.target }}
+          args: ${{ matrix.platform.build-args }} --package wstunnel-cli --target ${{ matrix.platform.target }}
 
       - name: Store artifact
         uses: actions/upload-artifact@v4

Cargo.lock

@@ -1,3 +1,6 @@
+[workspace]
+members = ["wstunnel-cli"]
+
 [package]
 name = "wstunnel"
 version = "10.1.8"
@@ -13,7 +16,7 @@ scopeguard = "1.2.0"
 
 bb8 = { version = "0.9.0", features = [] }
 bytes = { version = "1.9.0", features = [] }
-clap = { version = "4.5.23", features = ["derive", "env"] }
+clap = { version = "4.5.23", features = ["derive", "env"], optional = true }
 fast-socks5 = { version = "0.10.0", features = [] }
 fastwebsockets = { git = "https://github.com/erebe/fastwebsockets.git", features = ["upgrade", "simd", "unstable-split"] }
 futures-util = { version = "0.3.31" }
@@ -22,8 +25,6 @@ ppp = { version = "2.2.0", features = [] }
 async-channel = { version = "2.3.1", features = [] }
 arc-swap = { version = "1.7.1", features = [] }
 
-fdlimit = "0.3.0"
-
 # For config file parsing
 regex = { version = "1.11.1", default-features = false, features = ["std", "perf"] }
 serde_regex = "1.1.0"
@@ -45,11 +46,10 @@ rustls-pemfile = { version = "2.2.0", features = [] }
 x509-parser = "0.16.0"
 serde = { version = "1.0.216", features = ["derive"] }
 socket2 = { version = "0.5.8", features = [] }
-tokio = { version = "1.42.0", features = ["full"] }
+tokio = { version = "1.42.0", features = ["io-std", "net", "signal", "sync", "time"] }
 tokio-stream = { version = "0.1.17", features = ["net"] }
 
 tracing = { version = "0.1.41", features = ["log"] }
-tracing-subscriber = { version = "0.3.19", features = ["env-filter", "fmt", "local-time"] }
 url = "2.5.4"
 urlencoding = "2.1.3"
 uuid = { version = "1.11.0", features = ["v7", "serde"] }
@@ -80,6 +80,9 @@ derive_more = { version = "1.0.0", features = ["from"] }
 [target.'cfg(target_os = "macos")'.dev-dependencies]
 get_if_addrs = "0.5.3"
 
+[features]
+# Implements clap::Subcommand on config::Client and config::Server
+clap = ["dep:clap"]
 
 [profile.release]
 lto = "fat"

Cargo.toml

@@ -675,6 +675,6 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 and run those commands at the root of the project
 
 ```
-cargo build
+cargo build --package wstunnel-cli
 target/debug/wstunnel ...
 ```

README.md

@@ -12,6 +12,7 @@ pub enum TransportScheme {
 }
 
 impl TransportScheme {
+    #[cfg(feature = "clap")] // this is only used inside a clap value parser
     pub const fn values() -> &'static [Self] {
         &[Self::Ws, Self::Wss, Self::Http, Self::Https]
     }

src/config.rs

@@ -0,0 +1,22 @@
+[package]
+name = "wstunnel-cli"
+version = "10.1.8"
+edition = "2021"
+
+[dependencies]
+anyhow = "1.0.95"
+
+clap = { version = "4.5.23", features = ["derive", "env"] }
+
+fdlimit = "0.3.0"
+
+tokio = { version = "1.42.0", features = ["full"] }
+
+tracing = { version = "0.1.41", features = ["log"] }
+tracing-subscriber = { version = "0.3.19", features = ["env-filter", "fmt", "local-time"] }
+
+wstunnel = { path = ".." , features = ["clap"] }
+
+[[bin]]
+name = "wstunnel"
+path = "src/main.rs"

src/lib.rs

@@ -0,0 +1,97 @@
+use clap::Parser;
+use std::io;
+use std::str::FromStr;
+use tracing::warn;
+use tracing_subscriber::filter::Directive;
+use tracing_subscriber::EnvFilter;
+use wstunnel::config::{Client, Server};
+use wstunnel::LocalProtocol;
+use wstunnel::{run_client, run_server};
+
+/// Use Websocket or HTTP2 protocol to tunnel {TCP,UDP} traffic
+/// wsTunnelClient <---> wsTunnelServer <---> RemoteHost
+#[derive(clap::Parser, Debug)]
+#[command(author, version, about, verbatim_doc_comment, long_about = None)]
+pub struct Wstunnel {
+    #[command(subcommand)]
+    commands: Commands,
+
+    /// Disable color output in logs
+    #[arg(long, global = true, verbatim_doc_comment, env = "NO_COLOR")]
+    no_color: Option<String>,
+
+    /// *WARNING* The flag does nothing, you need to set the env variable *WARNING*
+    /// Control the number of threads that will be used.
+    /// By default, it is equal the number of cpus
+    #[arg(
+        long,
+        global = true,
+        value_name = "INT",
+        verbatim_doc_comment,
+        env = "TOKIO_WORKER_THREADS"
+    )]
+    nb_worker_threads: Option<u32>,
+
+    /// Control the log verbosity. i.e: TRACE, DEBUG, INFO, WARN, ERROR, OFF
+    /// for more details: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#example-syntax
+    #[arg(
+        long,
+        global = true,
+        value_name = "LOG_LEVEL",
+        verbatim_doc_comment,
+        env = "RUST_LOG",
+        default_value = "INFO"
+    )]
+    log_lvl: String,
+}
+
+#[derive(clap::Subcommand, Debug)]
+pub enum Commands {
+    Client(Box<Client>),
+    Server(Box<Server>),
+}
+
+#[tokio::main]
+async fn main() -> anyhow::Result<()> {
+    let args = Wstunnel::parse();
+
+    // Setup logging
+    let mut env_filter = EnvFilter::builder().parse(&args.log_lvl).expect("Invalid log level");
+    if !(args.log_lvl.contains("h2::") || args.log_lvl.contains("h2=")) {
+        env_filter = env_filter.add_directive(Directive::from_str("h2::codec=off").expect("Invalid log directive"));
+    }
+    let logger = tracing_subscriber::fmt()
+        .with_ansi(args.no_color.is_none())
+        .with_env_filter(env_filter);
+
+    // stdio tunnel capture stdio, so need to log into stderr
+    if let Commands::Client(args) = &args.commands {
+        if args
+            .local_to_remote
+            .iter()
+            .filter(|x| matches!(x.local_protocol, LocalProtocol::Stdio { .. }))
+            .count()
+            > 0
+        {
+            logger.with_writer(io::stderr).init();
+        } else {
+            logger.init()
+        }
+    } else {
+        logger.init();
+    };
+    if let Err(err) = fdlimit::raise_fd_limit() {
+        warn!("Failed to set soft filelimit to hard file limit: {}", err)
+    }
+
+    match args.commands {
+        Commands::Client(args) => {
+            run_client(*args).await?;
+        }
+        Commands::Server(args) => {
+            run_server(*args).await?;
+        }
+    }
+
+    Ok(())
+}