github.com/bvisonl/tunnel-radar

Tunnel Radar

🚧 Under development 🚧

A tool to manage your SSH tunnels

Requirements 📋

• Go if you want to build the project from source (otherwise download one of the releases)

Installation 👨‍💻

# Download from the repository
$ git clone https://github.com/bvisonl/tunnel-radar.git
$ cd tunnel-radar
$ go build -o tunnel-radar

You should see a tunnel-radar binary inside the folder

Installing the service 🚥

If you want the service to be registered as a service:

$ cp tunnel-radar.service /lib/system/systemd/tunnel-radar.service
$ systemctl daemon reload

Make sure to edit the tunnel-radar.service to specify the correct path to the configuration file. By default, it looks for it in /etc/tunnel-radar/config.yml

You should see a tunnel-radar binary inside the folder

Configuration 🛃

tunnel-radar feeds its configuration from a YAML file that. This is a full sample configuration:

tunnels:
  serverA:
    cliServerHost: "127.0.0.1"
    cliServerPort: 7779
    disabled: false # if true, this tunnel will have to be manually enabled
    source: "0.0.0.0:6000"
    remote: "127.0.0.1:6001"
    destination: "whoami:80"
    auth:
      user: "root"
      password: "root"
      # Either password or key are required
      # key: "/root/.ssh/id_rsa"

Usage 🏹

tunnel-radar exposes some flags:

• -c: Specify the configuration file to use
• -d: Enable additional debugging output
• -i: Enable CLI mode, this is used to run tunnel-radar's CLI to communicate with the service
• -ih: The host to connect to when using CLI (defaults to 127.0.0.1)
• -ip: The port to connect to when using CLI (defaults to 7779)

On Linux:

$ ./tunnel-radar -d -c config.yml

On Windows:

$ tunnel-radar.exe -d -c config.yml

You should see something like:

If so the service is ready to accept connections on the different enabled tunnels.

CLI Usage 💻

In order to run the cli to manage the tunnels you can use the same binary with the flags specified above:

$ ./tunnel-radar -d -i -ih 127.0.0.1 -ip 7779

The prompt of the CLI will show up and then you can start communicating with the service like:

As of right now these are the available commands:

• list/ls: Display the list of declared tunnels
• enable [alias]: Enables a tunnel
• disable [alias]: Disables a tunnel

TODO 🔨

• Add more configuration options
• Add retry in case tunnel goes down
• Add Makefile
• Docker deployment & Build
• Organize code structure
• Make use of channels to improve communication
• Improve error handling
• Improve reading of commands
• Handle connection changes more appropriately
• Add tests
• Run benchmarks
• Ansible deployment

Contribution 👨‍🏭

TBD.