Vortix

Abstract

1. Introduction

Every command supports --json; watch commands emit NDJSON. Run vortix --help for authoritative options.

Vortix gives WireGuard and OpenVPN users one keyboard-driven view of their tunnels and the network around them. It is useful when plain wg-quick or openvpn provides too little visibility, while a full desktop VPN client is too heavy or tied to one provider.

Vortix orchestrates the system wg, wg-quick, and openvpn implementations; it does not implement either VPN protocol itself.

2. Objective

Terminal UI for WireGuard and OpenVPN with real-time telemetry and leak guarding.

This project demonstrates how Rust can be applied to a real-world Cybersecurity & Ethical Hacking problem.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Rust toolchain (rustup / cargo)
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/Harry-kp/vortix.git
cd vortix

# macOS
brew install wireguard-tools openvpn

# Ubuntu / Debian
sudo apt install wireguard-tools openvpn

# Arch / CachyOS / Manjaro
sudo pacman -S wireguard-tools openvpn

# Fedora
sudo dnf install wireguard-tools openvpn

vortix import ./work.conf       # .conf, .ovpn, URL, or directory
sudo vortix                    # interactive dashboard

# Or stay in the CLI
sudo vortix up work
vortix status
sudo vortix down work

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add logging and alert notifications (email / Telegram)
• Write a threat model document for the tool
• Package it with Docker for safe lab testing

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Which threat or attack does this project defend against?
2. What detection or protection technique is used and what are its limits?
3. How are false positives and false negatives handled?
4. Which cryptographic algorithms or security standards are involved?
5. What legal and ethical rules apply when testing a tool like this?

9. Source Code & License

This project is developed by Harry-kp and published on GitHub under the MIT License. Please follow the license terms and credit the original author when you use or modify this code.