vortix 0.2.0

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

//! Platform abstraction layer for OS-specific functionality.
//!
//! This module provides trait-based abstractions for platform-specific operations,
//! with compile-time selection via `#[cfg]` conditional compilation.
//!
//! Supported platforms:
//! - macOS: pf firewall, netstat -ib, ifconfig, scutil/networksetup
//! - Linux: iptables/nftables, /proc/net/dev, ip addr, resolvectl

#[cfg(target_os = "linux")]
pub mod linux;
#[cfg(target_os = "macos")]
pub mod macos;

#[cfg(not(any(target_os = "macos", target_os = "linux")))]
compile_error!("Vortix currently only supports macOS and Linux");

use crate::core::killswitch::Result as KsResult;

// Re-export platform constants from the centralized constants module for convenience.
pub use crate::constants::DEFAULT_VPN_INTERFACE;
pub use crate::constants::KILLSWITCH_EMERGENCY_MSG;

// === Platform Trait Definitions ===

/// Firewall control for the kill switch.
///
/// Implementations block all non-VPN traffic when enabled.
pub trait Firewall {
    /// Enable kill switch by loading restrictive firewall rules.
    fn enable_blocking(vpn_interface: &str, vpn_server_ip: Option<&str>) -> KsResult<()>;

    /// Disable kill switch by flushing firewall rules.
    fn disable_blocking() -> KsResult<()>;
}

/// Network statistics collection.
///
/// Implementations read per-interface byte counters to calculate throughput.
pub trait NetworkStatsProvider {
    /// Get total bytes (in, out) across all non-loopback interfaces.
    fn get_total_bytes() -> (u64, u64);
}

/// VPN interface detection.
///
/// Implementations detect active `WireGuard` and `OpenVPN` interfaces.
pub trait InterfaceDetector {
    /// Check if a `WireGuard` interface exists by profile name.
    fn check_wireguard_interface(name: &str) -> bool;

    /// Get the real interface name for a `WireGuard` profile.
    fn resolve_wireguard_interface(name: &str) -> Option<String>;

    /// Get the PID of the `WireGuard` process managing an interface.
    fn get_wireguard_pid(interface: &str) -> Option<u32>;

    /// Get IP and MTU for an interface.
    fn get_interface_info(interface: &str) -> (String, String);
}

/// DNS resolver information.
///
/// Implementations query the system for the active DNS server.
pub trait DnsResolver {
    /// Get the current system DNS server address.
    fn get_dns_server() -> Option<String>;
}

/// Platform-appropriate install hint for a package.
#[cfg(target_os = "macos")]
#[must_use]
pub fn install_hint(pkg: &str) -> String {
    format!("brew install {pkg}")
}

#[cfg(target_os = "linux")]
#[must_use]
pub fn install_hint(pkg: &str) -> String {
    format!("sudo apt install {pkg}  # or: sudo dnf install {pkg}")
}