arti/subcommands/

proxy.rs

//! The `proxy` subcommand.

use std::sync::Arc;

use anyhow::{Context, Result};
use cfg_if::cfg_if;
use clap::ArgMatches;
#[allow(unused)]
use tor_config_path::CfgPathResolver;
use tracing::{info, instrument, warn};

use arti_client::TorClientConfig;
use tor_config::{ConfigurationSources, Listen};
use tor_rtcompat::ToplevelRuntime;

#[cfg(feature = "dns-proxy")]
use crate::dns;
use crate::{
    ArtiConfig, TorClient, exit, process,
    proxy::{self, ListenProtocols, port_info},
    reload_cfg,
};

#[cfg(feature = "rpc")]
use crate::rpc;

#[cfg(feature = "onion-service-service")]
use crate::onion_proxy;

/// Shorthand for a boxed and pinned Future.
type PinnedFuture<T> = std::pin::Pin<Box<dyn futures::Future<Output = T>>>;

/// Run the `proxy` subcommand.
#[instrument(skip_all, level = "trace")]
pub(crate) fn run<R: ToplevelRuntime>(
    runtime: R,
    proxy_matches: &ArgMatches,
    cfg_sources: ConfigurationSources,
    loaded_cfg: tor_config::ConfigurationTree,
    config: ArtiConfig,
    client_config: TorClientConfig,
) -> Result<()> {
    // Override configured listen addresses from the command line.
    // This implies listening on localhost ports.

    // TODO: Parse a string rather than calling new_localhost.
    let socks_listen = match proxy_matches.get_one::<u16>("socks-port") {
        Some(p) => Listen::new_localhost(*p),
        None => config.proxy().socks_listen.clone(),
    };

    // TODO: Parse a string rather than calling new_localhost.
    let dns_listen = match proxy_matches.get_one::<u16>("dns-port") {
        Some(p) => Listen::new_localhost(*p),
        None => config.proxy().dns_listen.clone(),
    };

    if !socks_listen.is_empty() {
        info!(
            "Starting Arti {} in proxy mode on {} ...",
            env!("CARGO_PKG_VERSION"),
            socks_listen
        );
    }

    if let Some(listen) = {
        // https://github.com/metrics-rs/metrics/issues/567
        config
            .metrics
            .prometheus
            .listen
            .single_address_legacy()
            .context("can only listen on a single address for Prometheus metrics")?
    } {
        cfg_if! {
            if #[cfg(feature = "metrics")] {
                metrics_exporter_prometheus::PrometheusBuilder::new()
                    .with_http_listener(listen)
                    .install()
                    .with_context(|| format!(
                        "set up Prometheus metrics exporter on {listen}"
                    ))?;
                info!("Arti Prometheus metrics export scraper endpoint http://{listen}");
            } else {
                return Err(anyhow::anyhow!(
        "`metrics.prometheus.listen` config set but `metrics` cargo feature compiled out in `arti` crate"
                ));
            }
        }
    }

    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    process::use_max_file_limit(&config);

    let rt_copy = runtime.clone();
    rt_copy.block_on(run_proxy(
        runtime,
        socks_listen,
        dns_listen,
        config.proxy().protocols(),
        cfg_sources,
        loaded_cfg,
        config,
        client_config,
    ))?;

    Ok(())
}

/// Run the main loop of the proxy.
///
/// # Panics
///
/// Currently, might panic if things go badly enough wrong
#[cfg_attr(feature = "experimental-api", visibility::make(pub))]
#[cfg_attr(docsrs, doc(cfg(feature = "experimental-api")))]
#[instrument(skip_all, level = "trace")]
#[expect(clippy::too_many_arguments)]
async fn run_proxy<R: ToplevelRuntime>(
    runtime: R,
    socks_listen: Listen,
    dns_listen: Listen,
    protocols: ListenProtocols,
    // TODO RPC Config: We are passing numerous types here in order to construct a CfgMgr.
    // Can we instead construct one earlier?  Or at least put them in a struct?
    config_sources: ConfigurationSources,
    loaded_cfg: tor_config::ConfigurationTree,
    arti_config: ArtiConfig,
    client_config: TorClientConfig,
) -> Result<()> {
    // Using OnDemand arranges that, while we are bootstrapping, incoming connections wait
    // for bootstrap to complete, rather than getting errors.
    use arti_client::BootstrapBehavior;
    use futures::FutureExt;

    // TODO: We may instead want to provide a way to get these items out of TorClient.
    let fs_mistrust = client_config.fs_mistrust().clone();
    let path_resolver: CfgPathResolver = AsRef::<CfgPathResolver>::as_ref(&client_config).clone();

    let defer_bootstrap = arti_config.application().defer_bootstrap;

    let bootstrap_behavior = match defer_bootstrap {
        true => BootstrapBehavior::Manual,
        false => BootstrapBehavior::OnDemand,
    };

    let (cfg_mgr, cfg_watcher_task) = reload_cfg::CfgMgr::new(
        runtime.clone(),
        config_sources,
        #[cfg(feature = "rpc")]
        loaded_cfg,
        &arti_config,
        vec![],
    )?;

    let client_builder = TorClient::with_runtime(runtime.clone())
        .config(client_config)
        .bootstrap_behavior(bootstrap_behavior);
    let client = client_builder.create_unbootstrapped_async().await?;

    let launchable_client = Arc::new(reload_cfg::LaunchableTorClient::new(
        Arc::clone(&client),
        arti_config.application(),
    ));

    #[allow(unused_mut)]
    let mut reconfigurable_modules: Vec<Arc<dyn reload_cfg::ReconfigurableModule>> = vec![
        Arc::clone(&launchable_client) as _,
        Arc::new(reload_cfg::Application::new(arti_config.clone())),
    ];

    cfg_if::cfg_if! {
        if #[cfg(feature = "onion-service-service")] {
            let have_onion_svc = if defer_bootstrap {
                let onion_services = onion_proxy::ProxySet::new_deferred(Arc::clone(&client));
                reconfigurable_modules.push(Arc::new(onion_services));
                arti_config.onion_services.values().any(|c| *c.svc_cfg.enabled())
            } else {
                let onion_services =
                    onion_proxy::ProxySet::launch_new(Arc::clone(&client), arti_config.onion_services.clone())?;
                let have_onion_svc = !onion_services.is_empty();
                reconfigurable_modules.push(Arc::new(onion_services));
                have_onion_svc
            };
        } else {
            let have_onion_svc = false;
        }
    };

    // The add_module function will use references here
    // to prevent the task spawned by watch_for_config_changes from
    // keeping these modules alive after this function exits.
    //
    // NOTE: reconfigurable_modules stores the only strong references to these modules,
    // so we must keep that variable alive until the end of the function
    reconfigurable_modules
        .iter()
        .try_for_each(|m| cfg_watcher_task.add_module(m))?;

    cfg_watcher_task.launch()?;

    cfg_if::cfg_if! {
        if #[cfg(feature = "rpc")] {
            let rpc_data = rpc::launch_rpc_mgr(
                &runtime,
                &arti_config.rpc,
                &path_resolver,
                &fs_mistrust,
                client.clone(),
                launchable_client.clone(),
                cfg_mgr.clone(),
            )
            .await?;
            let (rpc_mgr, mut rpc_state_sender) = rpc_data
                .map(|d| (d.rpc_mgr, d.rpc_state_sender))
                .unzip();
        } else {
            let rpc_mgr = None;
        }
    }

    // The options that we'll use for our listening proxy sockets.
    let mut listen_options = tor_rtcompat::TcpListenOptions::builder();
    listen_options
        .common()
        .send_buffer_size(Some(arti_config.proxy().socket_send_buf_size.as_usize()))
        .recv_buffer_size(Some(arti_config.proxy().socket_recv_buf_size.as_usize()));
    let listen_options = listen_options.build()?;

    let mut proxy: Vec<PinnedFuture<Result<()>>> = Vec::new();
    let mut ports = Vec::new();
    if !socks_listen.is_empty() {
        let runtime = runtime.clone();
        let client = client.isolated_client();
        let socks_listen = socks_listen.clone();
        let listener_type = protocols.to_string();

        let stream_proxy = proxy::bind_proxy(
            runtime,
            client,
            socks_listen,
            listen_options,
            protocols,
            rpc_mgr,
        )
        .await
        .with_context(|| format!("Unable to launch {listener_type} proxy"))?;
        let port_info = stream_proxy.port_info()?;

        ports.extend(port_info);

        let failure_message = format!("{listener_type} proxy died unexpectedly");
        let proxy_future = stream_proxy
            .run_proxy()
            .map(|future_result| future_result.context(failure_message));
        proxy.push(Box::pin(proxy_future));
    }

    #[cfg(feature = "dns-proxy")]
    if !dns_listen.is_empty() {
        let runtime = runtime.clone();
        let client = client.isolated_client();
        let dns_proxy = dns::bind_dns_resolver(runtime, client, dns_listen)
            .await
            .context("Unable to launch DNS proxy")?;
        ports.extend(dns_proxy.port_info().context("Unable to find DNS ports")?);
        let proxy_future = dns_proxy
            .run_dns_proxy()
            .map(|future_result| future_result.context("DNS proxy died unexpectedly"));
        proxy.push(Box::pin(proxy_future));
    }

    #[cfg(not(feature = "dns-proxy"))]
    if !dns_listen.is_empty() {
        warn!(
            "Tried to specify a DNS proxy address, but Arti was built without dns-proxy support."
        );
        return Ok(());
    }

    if proxy.is_empty() {
        if !have_onion_svc {
            // TODO: rename "socks_listen" to "proxy_listen", preserving compat, once http-connect is stable.
            warn!(
                "No proxy address set; \
                specify -p PORT (to override `socks_listen`) \
                or -d PORT (to override `dns_listen`). \
                Alternatively, use the `socks_listen` or `dns_listen` configuration options."
            );
            return Ok(());
        } else {
            // Push a dummy future to appease future::select_all,
            // which expects a non-empty list
            proxy.push(Box::pin(futures::future::pending()));
        }
    }

    cfg_if::cfg_if! {
        if #[cfg(feature="rpc")] {
            if let Some(rpc_state_sender) = &mut rpc_state_sender {
                rpc_state_sender.set_stream_listeners(&ports[..]);
            }
        }
    }

    {
        let port_info = port_info::PortInfo { ports };
        let port_info_file = arti_config
            .storage()
            .port_info_file
            .path(&path_resolver)
            .context("Can't find path for port_info_file")?;
        if port_info_file.to_str() != Some("") {
            port_info.write_to_file(&fs_mistrust, &port_info_file)?;
        }
    }

    let proxy = futures::future::select_all(proxy).map(|(finished, _index, _others)| finished);
    futures::select!(
        r = exit::wait_for_ctrl_c().fuse()
            => r.context("waiting for termination signal"),
        r = proxy.fuse()
            => r,
        r = async {
            if defer_bootstrap {
                info!("Bootstrapping deferred.");
            } else {
                client.bootstrap().await?;
                if !socks_listen.is_empty() {
                    info!("Sufficiently bootstrapped; proxy now functional.");
                } else {
                    info!("Sufficiently bootstrapped.");
                }
            }
            futures::future::pending::<Result<()>>().await
        }.fuse()
            => r.context("bootstrap"),
    )?;

    // The modules and CfgMgr can be dropped now, because we are exiting.
    // (We drop them explicitly to make sure that they were not dropped
    // accidentally before.)
    drop(reconfigurable_modules);
    drop(cfg_mgr);

    Ok(())
}