This repository contains a one-stop Terraform module that creates a single node OpenVPN Server cluster in a dedicated AWS VPC and subnet. The OpenVPN server is configured to be readily accessible by the users supplied in the Terraform input file. The same Terraform input file can be used to subsequently update the list of authorised users.
For further information, see the corresponding article on Ready to Use OpenVPN Servers in AWS For Everyone on How Hard Can It Be?!.
The master branch in this repository is compliant with Terraform v0.12; a legacy version that is compatible with Terraform v0.11 is available on branch [email protected].
Before you can use the Terraform module in this repository out of the box, you need
- an AWS account
- a Terraform CLI
- a list of users to provision with OpenVPN access
Moreover, you probably had enough of people snooping on you and want some privacy back or just prefer to have a long lived static IP.
After running the Terraform module in this repository you get
- an EC2 node running in a dedicated VPC and subnet
- an OpenVPN server bootstrapped on the EC2 node by the excellent openvpn-install.sh Bash script from https://github.com/angristan/openvpn-install
- SSH access to the OpenVPN sever locked down to the IP address of the machine executing the Terraform module (see the FAQs for how to handle drift over time)
- the list of users supplied as input to the Terraform module readily provisioned on the OpenVPN server
- the configuration of each user supplied in the Terraform configuration downloaded onto the local machine and ready for use
- the option to provision and revoke users from the OpenVPN server by simply re-running the Terraform module
The minimal setup leverages as much of the default settings in variables.tf as possible. However some input is required.
In order to bootstrap as well as manage the OpenVPN server, the Terraform module needs to SSH into the EC2 node. By default, it uses the public key in settings/openvpn.pub and the private key in settings/openvpn. Both can be created by executing the following command from the root directory of this repository
cd settings
ssh-keygen -f openvpn -t rsa
Here, hit return when prompted for a password in order to make the SSH keys passwordless.
The minimum input variables for the module are defined in settings/example.tfvars to be
aws_region = "<your-region>"
shared_credentials_file = "/path/to/.aws/credentials"
profile = "<your-profile>"
ovpn_users = ["userOne", "userTwo", "userThree"]Here, you need to replace the example values with your settings.
Moreover, note that users userOne, userTwo, and userThree will be provisioned with access to the OpenVPN sever and their configurations downloaded to the default location generated/ovpn-config.
Each user provisioned via input
ovpn_usersshould preferably be defined as a single word (i.e., no whitespace), consisting only of ASCII letters and numbers with underscores as delimiters; in technical terms, each user should adhere to^[a-zA-Z0-9_]+$.
All Terraform interactions are wrapped in helper Bash scripts for convenience.
Initialise Terraform by running
./terraform-bootstrap.sh
The OpenVPN server can be created and updated by running
./terraform-apply.sh <input-file-name>
where <input-file-name> references input file settings/<input-file-name>.tfvars.
When using input file settings/example.tfvars configured above, the command becomes
./terraform-apply.sh example
Under the bonnet, the terraform-apply.sh Bash script with input example
- selects or creates a new workspace called
example - executes
terraform applywhere the inputs are taken from input filesettings/example.tfvars - does not ask for permission to proceed as it uses
-auto-approvewhen running the underlyingterraform applycommand
By default, all .ovpn configurations for the users provisioned with access to the OpenVPN server in input ovpn_users are automatically downloaded to generated/ovpn-config.
Additionally, the Terraform module also outputs
- the
ec2_instance_dns - the
ec2_instance_ipand - a
connection_stringthat can be used to SSH into the EC2 node
The OpenVPN server can be deleted by running
./terraform-destroy.sh <input-file-name>
where <input-file-name> again references input file settings/<input-file-name>.tfvars.
When using input file settings/example.tfvars configured above, the command becomes
./terraform-destroy.sh example
Under the bonnet, the terraform-destroy.sh Bash script with input example
- selects the
exampleworkspace - executes
terraform destroywhere the inputs are taken from filesettings/example.tfvars - does ask for permission to proceed when running the
terraform applycommand
Once the Terraform module execution has successfully completed, the connection to the OpenVPN can be tested as follows.
While below instructions are specific to a recent Mac using Homebrew as a package manager, the actual underlying
openvpncommand should be fairly transferable to other platforms as well.
If not already present, install openvpn via brew by executing
brew install openvpn
Follow the instructions on screen and if the installation may need a little final nudge, try running
sudo brew services start openvpn
In case openvpn isn't readily available from the terminal after the installation above, a StackOverflow answer suggests to add the openvpn executable to the $PATH environment variable by executing
export PATH=$(brew --prefix openvpn)/sbin:$PATH
Assuming a valid OpenVPN configuration has been downloaded to generated/ovpn-config/userOne.ovpn , the connection can be tested by initiating the actual openvpn connection by running
sudo openvpn --config generated/ovpn-config/userOne.ovpn
Note that the above command will actually change your network settings and hence public IP.
This repository relies on the great openvpn-install.sh Bash script from https://github.com/angristan/openvpn-install to do the OpenVPN plumbing under the bonnet. Keep up the good work, Stanislas Lange, aka angristan!
Below is a list of frequently asked questions.
Most likely, the IP address of your machine executing the Terraform module has changed since the original installation. The security groups for the OpenVPN server are designed to only permit SSH access from a single predefined IP address. As this has drifted from the original value, you are being refused SSH access. But this scenario has been incorporated into the design of the Terraform module.
Just re-run the ./terraform-apply.sh Bash script again with your <input-file-name>. Terraform should pick up your new IP address and update the ingress rules for the security groups accordingly.
Custom domains are great for running an OpenVPN server at vpn.how-hard-can-it.be. However, depending on the domain, its age, and many other factors, a provider may choose to not resolve the domain which leaves the OpenVPN server unreachable when it may be needed the most.
Standard AWS URLs such as ec2-1-2-3-4.eu-west-2.compute.amazonaws.com tend to be resolved by most providers. It's probably not the most memorable URL but it tends to work in the places I personally care about.
Please refer to the excellent guide on Downloading and Installing Tunnelblick.
Please refer to the excellent guide on how to Install OpenVPN on iOS.
For transferring .ovpn configurations onto your iPhone, please refer to Transfer Files to Your Mobile By Scanning a QR Code.
Please refer to the excellent Guide to install OpenVPN Connect for Android.
For transferring .ovpn configurations onto your Android phone, please refer to Transfer Files to Your Mobile By Scanning a QR Code.
Simply add or remove the users from the list of ovpn_users in your settings/<input-file-name>.tfvars input file and re-run ./terraform-apply.sh <input-file-name> as described above.
This Terraform module has been deliberately kept simple. It's intended for personal use and to reclaim some lost privacy, security, and freedom. If you require professional or enterprise level VPN services, then there is a sheer abundance of commercial VPN providers to choose from.
This isn't to say that it wouldn't be a fun project to put the OpenVPN servers behind ASGs and ALBs and spin up bastion hosts on demand. However, this makes the key handling a bit more complicated. If you're interested, reach out and we can discuss over a pint.
On a side note: From personal experience, a single node OpenVPN cluster has served my digital family with a handful of more of less permanently connected devices well on a daily base over the course of the past six months. And running.
In one word: simplicity.
Terraform is great for provisioning (fairly static) infrastructure but there are more sophisticated tools out there for provisioning and maintaining elastic infrastructure at scale, let alone user provisioning and maintenance. For sake of simplicity, Terraform is being used as the single tool of choice in this case.
Yes. Find it. Solve it. Bag your reward. I'm looking forward to your solutions! Teach me something new!