Supply Proxy type to main_entry instead of individual args and adapt test cases

This commit is contained in:
B. Blechschmidt 2023-03-22 13:18:07 +01:00
parent 2f295c3fdc
commit e509a81d67
5 changed files with 118 additions and 122 deletions

View file

@ -20,3 +20,4 @@ nix = { version = "0.26", features = ["process", "signal"] }
prctl = "1.0" prctl = "1.0"
reqwest = { version = "0.11", features = ["blocking", "json"] } reqwest = { version = "0.11", features = ["blocking", "json"] }
serial_test = "1.0" serial_test = "1.0"
test-with = "0.9"

View file

@ -1,12 +1,64 @@
use crate::tun2proxy::Credentials; use crate::tun2proxy::Credentials;
use crate::{http::HttpManager, socks5::Socks5Manager, tun2proxy::TunToProxy}; use crate::{http::HttpManager, socks5::Socks5Manager, tun2proxy::TunToProxy};
use std::net::SocketAddr; use std::net::{SocketAddr, ToSocketAddrs};
pub mod http; pub mod http;
pub mod socks5; pub mod socks5;
pub mod tun2proxy; pub mod tun2proxy;
pub mod virtdevice; pub mod virtdevice;
#[derive(Clone, Debug)]
pub struct Proxy {
pub proxy_type: ProxyType,
pub addr: SocketAddr,
pub credentials: Option<Credentials>,
}
impl Proxy {
pub fn from_url(s: &str) -> Result<Proxy, String> {
let url = url::Url::parse(s).map_err(|_| format!("`{s}` is not a valid proxy URL"))?;
let host = url
.host_str()
.ok_or(format!("`{s}` does not contain a host"))?;
let mut url_host = String::from(host);
let port = url.port().ok_or(format!("`{s}` does not contain a port"))?;
url_host.push(':');
url_host.push_str(port.to_string().as_str());
let mut addr_iter = url_host
.to_socket_addrs()
.map_err(|_| format!("`{host}` could not be resolved"))?;
let addr = addr_iter
.next()
.ok_or(format!("`{host}` does not resolve to a usable IP address"))?;
let credentials = if url.username() == "" && url.password().is_none() {
None
} else {
let username = String::from(url.username());
let password = String::from(url.password().unwrap_or(""));
Some(Credentials::new(&username, &password))
};
let scheme = url.scheme();
let proxy_type = match url.scheme().to_ascii_lowercase().as_str() {
"socks5" => Some(ProxyType::Socks5),
"http" => Some(ProxyType::Http),
_ => None,
}
.ok_or(format!("`{scheme}` is an invalid proxy type"))?;
Ok(Proxy {
proxy_type,
addr,
credentials,
})
}
}
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)] #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Debug)]
pub enum ProxyType { pub enum ProxyType {
Socks5, Socks5,
@ -22,19 +74,14 @@ impl std::fmt::Display for ProxyType {
} }
} }
pub fn main_entry( pub fn main_entry(tun: &str, proxy: Proxy) {
tun: &str,
addr: SocketAddr,
proxy_type: ProxyType,
credentials: Option<Credentials>,
) {
let mut ttp = TunToProxy::new(tun); let mut ttp = TunToProxy::new(tun);
match proxy_type { match proxy.proxy_type {
ProxyType::Socks5 => { ProxyType::Socks5 => {
ttp.add_connection_manager(Socks5Manager::new(addr, credentials)); ttp.add_connection_manager(Socks5Manager::new(proxy.addr, proxy.credentials));
} }
ProxyType::Http => { ProxyType::Http => {
ttp.add_connection_manager(HttpManager::new(addr, credentials)); ttp.add_connection_manager(HttpManager::new(proxy.addr, proxy.credentials));
} }
} }
ttp.run(); ttp.run();

View file

@ -1,10 +1,7 @@
use std::net::{SocketAddr, ToSocketAddrs};
use clap::Parser; use clap::Parser;
use env_logger::Env; use env_logger::Env;
use tun2proxy::tun2proxy::Credentials; use tun2proxy::{main_entry, Proxy};
use tun2proxy::{main_entry, ProxyType};
/// Tunnel interface to proxy /// Tunnel interface to proxy
#[derive(Parser)] #[derive(Parser)]
@ -15,58 +12,8 @@ struct Args {
tun: String, tun: String,
/// The proxy URL in the form proto://[username[:password]@]host:port /// The proxy URL in the form proto://[username[:password]@]host:port
#[arg(short, long = "proxy", value_parser = proxy_url_parser, value_name = "URL")] #[arg(short, long = "proxy", value_parser = Proxy::from_url, value_name = "URL")]
proxy: ArgProxy, proxy: Proxy,
}
#[derive(Clone)]
struct ArgProxy {
proxy_type: ProxyType,
addr: SocketAddr,
credentials: Option<Credentials>,
}
fn proxy_url_parser(s: &str) -> Result<ArgProxy, String> {
let url = url::Url::parse(s).map_err(|_| format!("`{s}` is not a valid proxy URL"))?;
let host = url
.host_str()
.ok_or(format!("`{s}` does not contain a host"))?;
let mut url_host = String::from(host);
let port = url.port().ok_or(format!("`{s}` does not contain a port"))?;
url_host.push(':');
url_host.push_str(port.to_string().as_str());
let mut addr_iter = url_host
.to_socket_addrs()
.map_err(|_| format!("`{host}` could not be resolved"))?;
let addr = addr_iter
.next()
.ok_or(format!("`{host}` does not resolve to a usable IP address"))?;
let credentials = if url.username() == "" && url.password().is_none() {
None
} else {
let username = String::from(url.username());
let password = String::from(url.password().unwrap_or(""));
Some(Credentials::new(&username, &password))
};
let scheme = url.scheme();
let proxy_type = match url.scheme().to_ascii_lowercase().as_str() {
"socks5" => Some(ProxyType::Socks5),
"http" => Some(ProxyType::Http),
_ => None,
}
.ok_or(format!("`{scheme}` is an invalid proxy type"))?;
Ok(ArgProxy {
proxy_type,
addr,
credentials,
})
} }
fn main() { fn main() {
@ -77,5 +24,5 @@ fn main() {
let proxy_type = args.proxy.proxy_type; let proxy_type = args.proxy.proxy_type;
log::info!("Proxy {proxy_type} server: {addr}"); log::info!("Proxy {proxy_type} server: {addr}");
main_entry(&args.tun, addr, proxy_type, args.proxy.credentials); main_entry(&args.tun, args.proxy);
} }

View file

@ -162,7 +162,7 @@ struct ConnectionState {
handler: std::boxed::Box<dyn TcpProxy>, handler: std::boxed::Box<dyn TcpProxy>,
} }
#[derive(Default, Clone)] #[derive(Default, Clone, Debug)]
pub struct Credentials { pub struct Credentials {
pub(crate) username: Vec<u8>, pub(crate) username: Vec<u8>,
pub(crate) password: Vec<u8>, pub(crate) password: Vec<u8>,

View file

@ -2,36 +2,41 @@
mod tests { mod tests {
extern crate reqwest; extern crate reqwest;
use std::env;
use std::io::BufRead;
use std::net::SocketAddr;
use std::process::Command;
use std::string::ToString;
use fork::Fork; use fork::Fork;
use nix::sys::signal; use nix::sys::signal;
use nix::unistd::Pid; use nix::unistd::Pid;
use serial_test::serial; use serial_test::serial;
use std::env;
use std::io::BufRead; use tun2proxy::{main_entry, Proxy, ProxyType};
use std::net::{SocketAddr, ToSocketAddrs};
use std::process::Command;
use std::string::ToString;
use tun2proxy::{main_entry, ProxyType};
static TUN_TEST_DEVICE: &str = "tun0"; static TUN_TEST_DEVICE: &str = "tun0";
static ALL_ROUTES: [&str; 4] = ["0.0.0.0/1", "128.0.0.0/1", "::/1", "8000::/1"]; static ALL_ROUTES: [&str; 4] = ["0.0.0.0/1", "128.0.0.0/1", "::/1", "8000::/1"];
#[derive(Clone, Copy)] #[derive(Clone, Debug)]
struct Test { struct Test {
env: &'static str, proxy: Proxy,
proxy_type: ProxyType,
} }
static TESTS: [Test; 2] = [ fn proxy_from_env(env_var: &str) -> Result<Proxy, String> {
Test { let url =
env: "SOCKS5_SERVER", env::var(env_var).map_err(|_| format!("{env_var} environment variable not found"))?;
proxy_type: ProxyType::Socks5, Proxy::from_url(url.as_str()).map_err(|_| format!("{env_var} URL cannot be parsed"))
}, }
Test {
env: "HTTP_SERVER", fn test_from_env(env_var: &str) -> Result<Test, String> {
proxy_type: ProxyType::Http, let proxy = proxy_from_env(env_var)?;
}, Ok(Test { proxy })
]; }
fn tests() -> [Result<Test, String>; 2] {
[test_from_env("SOCKS5_SERVER"), test_from_env("HTTP_SERVER")]
}
#[cfg(test)] #[cfg(test)]
#[ctor::ctor] #[ctor::ctor]
@ -48,17 +53,14 @@ mod tests {
.expect("failed to delete tun device"); .expect("failed to delete tun device");
} }
fn parse_server_addr(string: String) -> SocketAddr {
return string.to_socket_addrs().unwrap().next().unwrap();
}
fn routes_setup() { fn routes_setup() {
let mut all_servers: Vec<SocketAddr> = Vec::new(); let mut all_servers: Vec<SocketAddr> = Vec::new();
for test in TESTS { for test in tests() {
if let Ok(server) = env::var(test.env) { if test.is_err() {
all_servers.push(parse_server_addr(server)); continue;
} }
all_servers.push(test.unwrap().proxy.addr);
} }
Command::new("ip") Command::new("ip")
@ -116,18 +118,12 @@ mod tests {
where where
F: Fn(&Test) -> bool, F: Fn(&Test) -> bool,
{ {
for test in TESTS { for potential_test in tests() {
if !filter(&test) { match potential_test {
Ok(test) => {
if filter(&test) {
continue; continue;
} }
let env_var = env::var(test.env).expect(
format!(
"this test requires the {} environment variable to be set",
test.env
)
.as_str(),
);
let address = parse_server_addr(env_var);
match fork::fork() { match fork::fork() {
Ok(Fork::Parent(child)) => { Ok(Fork::Parent(child)) => {
@ -140,22 +136,27 @@ mod tests {
} }
Ok(Fork::Child) => { Ok(Fork::Child) => {
prctl::set_death_signal(signal::SIGKILL as isize).unwrap(); // 9 == SIGKILL prctl::set_death_signal(signal::SIGKILL as isize).unwrap(); // 9 == SIGKILL
main_entry(TUN_TEST_DEVICE, address, ProxyType::Socks5, None); main_entry(TUN_TEST_DEVICE, test.proxy);
} }
Err(_) => assert!(false), Err(_) => assert!(false),
} }
} }
Err(_) => {
continue;
}
}
}
} }
#[test]
#[serial] #[serial]
#[test_with::env(SOCKS5_SERVER)]
fn test_socks5() { fn test_socks5() {
run_test(|test| test.proxy_type == ProxyType::Socks5) run_test(|test| test.proxy.proxy_type == ProxyType::Socks5)
} }
#[test]
#[serial] #[serial]
#[test_with::env(HTTP_SERVER)]
fn test_http() { fn test_http() {
run_test(|test| test.proxy_type == ProxyType::Http) run_test(|test| test.proxy.proxy_type == ProxyType::Http)
} }
} }