overtls 0.3.8

A simple proxy tunnel, minimalist tool for bypassing the GFW.
Documentation
pub(crate) mod android;
pub(crate) mod api;
pub(crate) mod client;
pub(crate) mod cmdopt;
pub(crate) mod config;
pub(crate) mod dns;
pub(crate) mod dump_logger;
pub(crate) mod error;
pub(crate) mod server;
pub(crate) mod tcp_stream;
pub(crate) mod tls;
pub(crate) mod traffic_audit;
pub(crate) mod traffic_status;
pub(crate) mod udprelay;
pub(crate) mod webapi;
pub(crate) mod weirduri;
pub mod win_svc;

pub use api::{over_tls_client_run, over_tls_client_run_with_ssr_url, over_tls_client_stop, overtls_free_string, overtls_generate_url};
use bytes::BytesMut;
pub use client::run_client;
pub use cmdopt::{ArgVerbosity, CmdOpt, Role};
pub use config::{Client as ClientConfig, Config, ManageClients, Server as ServerConfig, TunnelPath};
pub use dump_logger::overtls_set_log_callback;
pub use error::{BoxError, Error, Result};
pub use server::run_server;
use socks5_impl::protocol::{Address, StreamOperation};
pub use tokio_util::sync::CancellationToken;
pub use traffic_status::{TrafficStatus, overtls_set_traffic_status_callback};

#[cfg(target_os = "windows")]
pub(crate) const STREAM_BUFFER_SIZE: usize = 1024 * 32;
#[cfg(not(target_os = "windows"))]
pub(crate) const STREAM_BUFFER_SIZE: usize = 1024 * 32 * 3;

pub(crate) fn ensure_rustls_crypto_provider() -> Result<()> {
    if rustls::crypto::CryptoProvider::get_default().is_some() {
        return Ok(());
    }

    let install_result = rustls::crypto::ring::default_provider().install_default();

    if rustls::crypto::CryptoProvider::get_default().is_none() {
        if let Err(e) = install_result {
            return Err(Error::from(format!("failed to install rustls ring CryptoProvider: {e:?}")));
        } else {
            return Err(Error::from(
                "failed to install rustls ring CryptoProvider: provider is still not set after successful installation",
            ));
        }
    }

    Ok(())
}

pub(crate) fn addess_to_b64str(addr: &Address, url_safe: bool) -> String {
    let mut buf = BytesMut::with_capacity(1024);
    addr.write_to_buf(&mut buf);
    if url_safe {
        base64easy::encode(&buf, base64easy::EngineKind::UrlSafeNoPad)
    } else {
        base64easy::encode(&buf, base64easy::EngineKind::StandardNoPad)
    }
}

pub(crate) fn b64str_to_address(s: &str, url_safe: bool) -> Result<Address> {
    let buf = if url_safe {
        let result = base64easy::decode(s, base64easy::EngineKind::UrlSafeNoPad);
        if result.is_err() {
            base64easy::decode(s, base64easy::EngineKind::UrlSafe)?
        } else {
            result?
        }
    } else {
        let result = base64easy::decode(s, base64easy::EngineKind::StandardNoPad);
        if result.is_err() {
            // backward compatibility for SSRoT
            base64easy::decode(s, base64easy::EngineKind::Standard)?
        } else {
            result?
        }
    };
    Address::try_from(&buf[..]).map_err(|e| e.into())
}

#[doc(hidden)]
pub async fn async_main(config: Config, allow_shutdown: bool, shutdown_token: CancellationToken) -> Result<()> {
    let ctrlc_fired = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false));
    let mut ctrlc_handle = None;
    if allow_shutdown {
        let shutdown_token_clone = shutdown_token.clone();
        let ctrlc_fired_clone = ctrlc_fired.clone();
        let handle = ctrlc2::AsyncCtrlC::new(move || {
            log::info!("Ctrl-C received, exiting...");
            ctrlc_fired_clone.store(true, std::sync::atomic::Ordering::SeqCst);
            shutdown_token_clone.cancel();
            true
        })?;
        ctrlc_handle = Some(handle);
    }

    let main_body = async {
        if config.is_server {
            if config.exist_server() {
                run_server(&config, shutdown_token).await?;
            } else {
                return Err(Error::from("Config is not a server config"));
            }
        } else if config.exist_client() {
            let callback = |addr| {
                log::trace!("Listening on {addr}");
            };
            run_client(&config, shutdown_token, Some(callback)).await?;
        } else {
            return Err("Config is not a client config".into());
        }

        if ctrlc_fired.load(std::sync::atomic::Ordering::SeqCst) {
            let Some(handle) = ctrlc_handle else {
                return Ok(());
            };
            log::info!("Waiting for Ctrl-C handler to finish...");
            handle.await.map_err(|e| e.to_string())?;
        }
        Ok(())
    };

    if let Err(e) = main_body.await {
        log::error!("main_body error: \"{e}\"");
    }

    Ok(())
}