vortix 0.3.1

Terminal UI for WireGuard and OpenVPN with real-time telemetry and leak guarding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258

//! Linux iptables/nftables firewall implementation for kill switch.
//!
//! Prefers iptables when available, falls back to nftables (nft).

use crate::vortix_core::ports::killswitch::{Killswitch, KillswitchError, Result};
use crate::vortix_process::{CommandSpec, PrivilegeReq};
use tracing::{debug, error, info};

const CHAIN_NAME: &str = "VORTIX_KILLSWITCH";
const NFT_TABLE: &str = "vortix_killswitch";

/// Detected firewall backend on this system.
enum FirewallBackend {
    Iptables,
    Nftables,
}

/// Linux firewall implementation supporting iptables and nftables.
pub struct IptablesFirewall;

impl IptablesFirewall {
    /// Detect which firewall backend is available, preferring iptables.
    fn detect_backend() -> Option<FirewallBackend> {
        if Self::has_iptables() {
            Some(FirewallBackend::Iptables)
        } else if Self::has_nft() {
            Some(FirewallBackend::Nftables)
        } else {
            None
        }
    }

    fn has_iptables() -> bool {
        crate::vortix_process::run_to_output(CommandSpec::oneshot(
            "iptables",
            vec!["--version".into()],
        ))
        .is_ok_and(|o| o.status.success())
    }

    fn has_nft() -> bool {
        crate::vortix_process::run_to_output(CommandSpec::oneshot("nft", vec!["--version".into()]))
            .is_ok_and(|o| o.status.success())
    }

    // ─── iptables backend ───────────────────────────────────────────────

    /// Run an iptables command and return success.
    fn iptables(args: &[&str]) -> std::result::Result<(), String> {
        let owned: Vec<String> = args.iter().map(|s| (*s).to_string()).collect();
        let output = crate::vortix_process::run_to_output(
            CommandSpec::oneshot("iptables", owned).privilege(PrivilegeReq::Root),
        )
        .map_err(|e| format!("Failed to run iptables: {e}"))?;

        if output.status.success() {
            Ok(())
        } else {
            Err(String::from_utf8_lossy(&output.stderr).to_string())
        }
    }

    /// Set up the kill switch chain with iptables.
    fn setup_iptables(vpn_interface: &str, vpn_server_ip: Option<&str>) -> Result<()> {
        // Create custom chain (ignore error if already exists)
        let _ = Self::iptables(&["-N", CHAIN_NAME]);

        // Flush existing rules in our chain
        Self::iptables(&["-F", CHAIN_NAME])
            .map_err(|e| KillswitchError::CommandFailed(format!("flush chain: {e}")))?;

        // Add rules to our chain

        // Allow loopback
        Self::iptables(&["-A", CHAIN_NAME, "-o", "lo", "-j", "ACCEPT"])
            .map_err(|e| KillswitchError::CommandFailed(format!("allow lo: {e}")))?;

        // Allow VPN interface
        Self::iptables(&["-A", CHAIN_NAME, "-o", vpn_interface, "-j", "ACCEPT"])
            .map_err(|e| KillswitchError::CommandFailed(format!("allow VPN iface: {e}")))?;

        // Allow local network (RFC1918)
        for net in &["192.168.0.0/16", "10.0.0.0/8", "172.16.0.0/12"] {
            Self::iptables(&["-A", CHAIN_NAME, "-d", net, "-j", "ACCEPT"])
                .map_err(|e| KillswitchError::CommandFailed(format!("allow {net}: {e}")))?;
        }

        // Allow DHCP
        Self::iptables(&[
            "-A", CHAIN_NAME, "-p", "udp", "--sport", "68", "--dport", "67", "-j", "ACCEPT",
        ])
        .map_err(|e| KillswitchError::CommandFailed(format!("allow DHCP: {e}")))?;

        // Allow VPN server IP if known (for reconnection)
        if let Some(ip) = vpn_server_ip {
            Self::iptables(&["-A", CHAIN_NAME, "-d", ip, "-p", "udp", "-j", "ACCEPT"]).map_err(
                |e| KillswitchError::CommandFailed(format!("allow VPN server udp: {e}")),
            )?;
            Self::iptables(&["-A", CHAIN_NAME, "-d", ip, "-p", "tcp", "-j", "ACCEPT"]).map_err(
                |e| KillswitchError::CommandFailed(format!("allow VPN server tcp: {e}")),
            )?;
        }

        // Default: drop everything else
        Self::iptables(&["-A", CHAIN_NAME, "-j", "DROP"])
            .map_err(|e| KillswitchError::CommandFailed(format!("default drop: {e}")))?;

        // Insert jump to our chain at the top of OUTPUT
        // First remove any existing jump (ignore error)
        let _ = Self::iptables(&["-D", "OUTPUT", "-j", CHAIN_NAME]);
        Self::iptables(&["-I", "OUTPUT", "1", "-j", CHAIN_NAME])
            .map_err(|e| KillswitchError::CommandFailed(format!("insert jump: {e}")))?;

        Ok(())
    }

    /// Remove the kill switch chain from iptables.
    fn teardown_iptables() {
        // Remove jump from OUTPUT chain (ignore error if not present)
        let _ = Self::iptables(&["-D", "OUTPUT", "-j", CHAIN_NAME]);

        // Flush and delete our custom chain
        let _ = Self::iptables(&["-F", CHAIN_NAME]);
        let _ = Self::iptables(&["-X", CHAIN_NAME]);
    }

    // ─── nftables backend ───────────────────────────────────────────────

    fn nft(args: &[&str]) -> std::result::Result<(), String> {
        let owned: Vec<String> = args.iter().map(|s| (*s).to_string()).collect();
        let output = crate::vortix_process::run_to_output(
            CommandSpec::oneshot("nft", owned).privilege(PrivilegeReq::Root),
        )
        .map_err(|e| format!("Failed to run nft: {e}"))?;

        if output.status.success() {
            Ok(())
        } else {
            Err(String::from_utf8_lossy(&output.stderr).to_string())
        }
    }

    /// Set up the kill switch with nftables using an atomic ruleset load.
    fn setup_nftables(vpn_interface: &str, vpn_server_ip: Option<&str>) -> Result<()> {
        use std::fmt::Write;

        let mut ruleset = format!(
            r#"table inet {NFT_TABLE} {{
  chain output {{
    type filter hook output priority 0; policy drop;

    # Allow loopback
    oifname "lo" accept

    # Allow VPN interface
    oifname "{vpn_interface}" accept

    # Allow local networks (RFC1918)
    ip daddr 192.168.0.0/16 accept
    ip daddr 10.0.0.0/8 accept
    ip daddr 172.16.0.0/12 accept

    # Allow DHCP
    udp sport 68 udp dport 67 accept
"#,
        );

        if let Some(ip) = vpn_server_ip {
            let _ = write!(
                ruleset,
                "\n    # Allow VPN server for reconnection\n    ip daddr {ip} accept\n"
            );
        }

        ruleset.push_str("  }\n}\n");

        // Delete existing table first (ignore error if not present)
        let _ = Self::nft(&["delete", "table", "inet", NFT_TABLE]);

        // Apply the full ruleset atomically via stdin
        let output = crate::vortix_process::run_to_output(
            CommandSpec::oneshot("nft", vec!["-f".into(), "-".into()])
                .privilege(PrivilegeReq::Root)
                .stdin(ruleset.into_bytes()),
        )
        .map_err(|e| KillswitchError::CommandFailed(format!("nft spawn: {e}")))?;

        if !output.status.success() {
            return Err(KillswitchError::CommandFailed(
                "nft failed to load ruleset".to_string(),
            ));
        }

        Ok(())
    }

    /// Remove the kill switch nftables table.
    fn teardown_nftables() {
        let _ = Self::nft(&["delete", "table", "inet", NFT_TABLE]);
    }
}

fn is_root() -> bool {
    // SAFETY: `geteuid` is a thread-safe getter with no side effects.
    #[allow(unsafe_code)]
    unsafe {
        libc::geteuid() == 0
    }
}

impl Killswitch for IptablesFirewall {
    fn enable_blocking(vpn_interface: &str, vpn_server_ip: Option<&str>) -> Result<()> {
        info!(
            target: "vortix::killswitch",
            interface = %vpn_interface,
            server = ?vpn_server_ip,
            "killswitch.engage"
        );

        if !is_root() {
            error!(target: "vortix::killswitch", "kill switch requires root privileges");
            return Err(KillswitchError::NotRoot);
        }

        match Self::detect_backend() {
            Some(FirewallBackend::Iptables) => {
                debug!(target: "vortix::killswitch", "using iptables backend");
                Self::setup_iptables(vpn_interface, vpn_server_ip)?;
            }
            Some(FirewallBackend::Nftables) => {
                debug!(target: "vortix::killswitch", "using nftables backend");
                Self::setup_nftables(vpn_interface, vpn_server_ip)?;
            }
            None => {
                return Err(KillswitchError::NoBackendAvailable);
            }
        }

        info!(target: "vortix::killswitch", "kill switch ACTIVE — blocking non-VPN traffic");
        Ok(())
    }

    fn disable_blocking() -> Result<()> {
        info!(target: "vortix::killswitch", "disabling kill switch");

        if !is_root() {
            error!(target: "vortix::killswitch", "disabling kill switch requires root");
            return Err(KillswitchError::NotRoot);
        }

        // Clean up both backends — safe to call on each even if not active
        Self::teardown_iptables();
        Self::teardown_nftables();

        info!(target: "vortix::killswitch", "kill switch DISABLED — normal traffic restored");
        Ok(())
    }
}