New Tunnel trait + 5 implementations:
- NoneTunnel: local-only, no external exposure (default)
- CloudflareTunnel: wraps cloudflared binary, extracts public URL
- TailscaleTunnel: tailscale serve (tailnet) or funnel (public)
- NgrokTunnel: wraps ngrok binary, supports custom domains
- CustomTunnel: user-provided command with {port}/{host} placeholders
Config schema:
- [tunnel] section with provider selector
- Provider-specific sub-configs: cloudflare, tailscale, ngrok, custom
- Backward compatible (serde default = "none")
Gateway integration:
- Tunnel starts automatically on 'zeroclaw gateway'
- Prints public URL on success, falls back to local on failure
20 new tests (factory, constructors, NoneTunnel async start/health)
649 tests passing, 0 clippy warnings, cargo fmt clean
145 lines
5 KiB
Rust
145 lines
5 KiB
Rust
use super::{kill_shared, new_shared_process, SharedProcess, Tunnel, TunnelProcess};
|
|
use anyhow::{bail, Result};
|
|
use tokio::io::AsyncBufReadExt;
|
|
use tokio::process::Command;
|
|
|
|
/// Custom Tunnel — bring your own tunnel binary.
|
|
///
|
|
/// Provide a `start_command` with `{port}` and `{host}` placeholders.
|
|
/// Optionally provide a `url_pattern` regex to extract the public URL
|
|
/// from stdout, and a `health_url` to poll for liveness.
|
|
///
|
|
/// Examples:
|
|
/// - `bore local {port} --to bore.pub`
|
|
/// - `frp -c /etc/frp/frpc.ini`
|
|
/// - `ssh -R 80:localhost:{port} serveo.net`
|
|
pub struct CustomTunnel {
|
|
start_command: String,
|
|
health_url: Option<String>,
|
|
url_pattern: Option<String>,
|
|
proc: SharedProcess,
|
|
}
|
|
|
|
impl CustomTunnel {
|
|
pub fn new(
|
|
start_command: String,
|
|
health_url: Option<String>,
|
|
url_pattern: Option<String>,
|
|
) -> Self {
|
|
Self {
|
|
start_command,
|
|
health_url,
|
|
url_pattern,
|
|
proc: new_shared_process(),
|
|
}
|
|
}
|
|
}
|
|
|
|
#[async_trait::async_trait]
|
|
impl Tunnel for CustomTunnel {
|
|
fn name(&self) -> &str {
|
|
"custom"
|
|
}
|
|
|
|
async fn start(&self, local_host: &str, local_port: u16) -> Result<String> {
|
|
let cmd = self
|
|
.start_command
|
|
.replace("{port}", &local_port.to_string())
|
|
.replace("{host}", local_host);
|
|
|
|
let parts: Vec<&str> = cmd.split_whitespace().collect();
|
|
if parts.is_empty() {
|
|
bail!("Custom tunnel start_command is empty");
|
|
}
|
|
|
|
let mut child = Command::new(parts[0])
|
|
.args(&parts[1..])
|
|
.stdout(std::process::Stdio::piped())
|
|
.stderr(std::process::Stdio::piped())
|
|
.kill_on_drop(true)
|
|
.spawn()?;
|
|
|
|
let mut public_url = format!("http://{local_host}:{local_port}");
|
|
|
|
// If a URL pattern is provided, try to extract the public URL from stdout
|
|
if let Some(ref pattern) = self.url_pattern {
|
|
if let Some(stdout) = child.stdout.take() {
|
|
let mut reader = tokio::io::BufReader::new(stdout).lines();
|
|
let deadline = tokio::time::Instant::now() + tokio::time::Duration::from_secs(15);
|
|
|
|
while tokio::time::Instant::now() < deadline {
|
|
let line = tokio::time::timeout(
|
|
tokio::time::Duration::from_secs(3),
|
|
reader.next_line(),
|
|
)
|
|
.await;
|
|
|
|
match line {
|
|
Ok(Ok(Some(l))) => {
|
|
tracing::debug!("custom-tunnel: {l}");
|
|
// Simple substring match on the pattern
|
|
if l.contains(pattern)
|
|
|| l.contains("https://")
|
|
|| l.contains("http://")
|
|
{
|
|
// Extract URL from the line
|
|
if let Some(idx) = l.find("https://") {
|
|
let url_part = &l[idx..];
|
|
let end = url_part
|
|
.find(|c: char| c.is_whitespace())
|
|
.unwrap_or(url_part.len());
|
|
public_url = url_part[..end].to_string();
|
|
break;
|
|
} else if let Some(idx) = l.find("http://") {
|
|
let url_part = &l[idx..];
|
|
let end = url_part
|
|
.find(|c: char| c.is_whitespace())
|
|
.unwrap_or(url_part.len());
|
|
public_url = url_part[..end].to_string();
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
Ok(Ok(None) | Err(_)) => break,
|
|
Err(_) => {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
let mut guard = self.proc.lock().await;
|
|
*guard = Some(TunnelProcess {
|
|
child,
|
|
public_url: public_url.clone(),
|
|
});
|
|
|
|
Ok(public_url)
|
|
}
|
|
|
|
async fn stop(&self) -> Result<()> {
|
|
kill_shared(&self.proc).await
|
|
}
|
|
|
|
async fn health_check(&self) -> bool {
|
|
// If a health URL is configured, try to reach it
|
|
if let Some(ref url) = self.health_url {
|
|
return reqwest::Client::new()
|
|
.get(url)
|
|
.timeout(std::time::Duration::from_secs(5))
|
|
.send()
|
|
.await
|
|
.is_ok();
|
|
}
|
|
|
|
// Otherwise check if the process is still alive
|
|
let guard = self.proc.lock().await;
|
|
guard.as_ref().is_some_and(|tp| tp.child.id().is_some())
|
|
}
|
|
|
|
fn public_url(&self) -> Option<String> {
|
|
self.proc
|
|
.try_lock()
|
|
.ok()
|
|
.and_then(|g| g.as_ref().map(|tp| tp.public_url.clone()))
|
|
}
|
|
}
|