benwebber/tunnelblickctl

:lock: Command-line interface for Tunnelblick

tunnelblickctl

Command-line interface for Tunnelblick, the de facto OpenVPN client for OS X.

Install

Install latest release with Homebrew

brew tap benwebber/tunnelblickctl
brew install tunnelblickctl

Install manually

Download one of the pre-compiled releases, extract it, then copy tunnelblickctl to somewhere on your $PATH.

Usage

$ tunnelblickctl help
tunnelblickctl

USAGE:
    tunnelblickctl [SUBCOMMAND]

FLAGS:
    -h, --help    Prints help information

SUBCOMMANDS:
    connect       Connect to a VPN
    disconnect    Disconnect from a VPN
    help          Prints this message or the help of the given subcommand(s)
    install       Install an OpenVPN or Tunnelblick configuration
    launch        Launch Tunnelblick
    list          List VPN configurations [aliases: ls]
    quit          Quit Tunnelblick
    status        Show VPN connection status
    version       Show version information

License

MIT

tunnelblickctl's Issues

brew formula needed

This really ought to be installed via brew install tunnelblickctl. Are you open to that?

Replace AppleScript with JavaScript

In OS X 10.10, Apple released a JavaScript interface for automation.

Apple tends to support the current version of macOS and the previous two versions. I think it's pretty safe to assume users will be able to use the JavaScript interface.

We'd be able to drop the custom AppleScript wrapper for Armin Ronacher's osascript package:

https://github.com/mitsuhiko/rust-osascript

Human-readable TX/RX values

• Parse delimited data returned from AppleScript.
• Convert TX/RX values to human-readable sizes using humansize.
• Make new behaviour default; make old behaviour configurable with a command-line flag.

Handle unknown VPNs on connect/disconnect

tunnelblickctl disconnect ignores unknown VPNs silently.

tunnelblickctl connect throws an AppleScript error.

Add format specifiers to status output

Now that we use serde, we can output status information in a variety of formats, such as delimited text (CSV/TSV/ASCII), JSON, and a line-oriented format:

name = tunnel
state = CONNECTED
autoconnect = NO
bytesOut = 1024
bytesIn = 1024

Command to support importing an ovpn config file

Would be awesome if there were support for important an ovpn config file. My use case is that I hop on and off new VPNs throughout the day (generated for cloud infra), so I'm constantly having to import these.

Error: Json(Error("missing field `data`", line: 1, column: 20))

Error

When I install a new cfg file, I got the following error

tunnelblickctl install openvpn-config/viscosity-ams2.cfg
Error: Json(Error("missing field `data`", line: 1, column: 20))

Add command to uninstall tunnels

Continuing #3, we should have a command to uninstall configurations by name:

# Installs configuration as "vpn.example.org"
tunnelblickctl install vpn.example.org.ovpn

# Uninstalls configuration
tunnelblickctl uninstall vpn.example.org

It's not sufficient to remove the configuration from ~/Library/Application Support/Tunnelblick/Configurations or its system equivalent, because Tunnelblick installs backup shadow configurations.

I think we will need to script the Tunnelblick GUI, which may require users to allow tunnelblickctl to control the GUI in System Preferences.