Awesome Open Source
Awesome Open Source

Go Report Card

Luzifer / vault-openvpn

vault-openvpn is a small wrapper utility to manage OpenVPN configuration combined with a Vault PKI. It enables administrators with Vault access to create client / server configurations with only one command. No more hazzle to manage that easyrsa PKI, just some few commands to set up a Vault PKI and you're done.

Setting up Vault for this

The Vault setup follows the Quick Start from the Vault documentation and is personalized for me so you need to adapt it to your domain if you want to follow it:

  • Mount PKI for my domain
    vault mount -path=luzifer_io pki
  • Enable long TTLs
    vault mount-tune -max-lease-ttl=87600h luzifer_io
  • Generate a root certificate
    vault write luzifer_io/root/generate/internal ttl=87600h
  • Set CA / CRL URLs
    vault write luzifer_io/config/urls issuing_certificates=${VAULT_ADDR}/v1/luzifer_io/ca crl_distribution_points=${VAULT_ADDR}/v1/luzifer_io/crl
  • Set a rule for OpenVPN certificates
    vault write luzifer_io/roles/openvpn allowed_domains="" allow_subdomains="true" max_ttl="8760h" ttl="8760h" allow_ip_sans=false allow_localhost=false

That's all you need to do to set up a whole PKI for your OpenVPN.

Configuration of the tool

You can pass all configurations through commandline-parameters. To see the available options and their defaults use the vault-openvpn --help flag.

Additionally most of the parameters are also supported to be set using a configuration file to be stored in ~/.config/vault-openvpn.yaml. To use that file you need to specify the arguments to the flags together with the flag name:

log-level: debug
template-path: /path/to/templates

The flags not supported to be set through that file are vault-addr, vault-token and version. First two for security reasons, last because it does not make sense.

Issuing configurations

You need to create a folder containing two files: client.conf and server.conf. Those two are templates to use for generating the configuration file used by vault-openvpn. Inside those files paste this block which will get replaced by the certificates:

{{ .CertAuthority }}

{{ .Certificate }}

{{ .PrivateKey }}

For the server configuration an additional block is available in case you don't want to generate your DH parameters with an external command:

{{ dhparam <bitsize> [generator] }}

In this function call you must specify <bitsize> (for example 2048) and may specify the [generator]. If the generator is not specified the default generator is set to 2. Please ensure you are not using this block in your client.conf as OpenVPN will not accept it there.

The configurations generated by this tool will not need multiple files but include the certificates inside the configuration. This makes it far more easy to pass them to your users. No unzip, no questions where to put the files, mostly the OpenVPN clients will know how to handle something called my-vpn.conf.

After you've set up your folder (you also could use one of the example configurations in the example folder of this repository) you can issue your servers configuration:

$ vault-openvpn --auto-revoke --pki-mountpoint luzifer_io server


And also you can generate client configurations:

$ vault-openvpn --auto-revoke --pki-mountpoint luzifer_io client
remote 1194 udp


In case someone needs to get removed from your OpenVPN there is also a revoke:

$ vault-openvpn --auto-revoke --pki-mountpoint luzifer_io revoke
2016/07/25 15:06:58 Found certificate 33:e1:0c:85:36:a5:c2:6b:05:85:f5:aa:9f:3b:f3:3a:a2:e0:ae:b0 with CN
2016/07/25 15:06:58 Revoked certificate 33:e1:0c:85:36:a5:c2:6b:05:85:f5:aa:9f:3b:f3:3a:a2:e0:ae:b0

To have revokes being executed by OpenVPN you need to periodically update the CRL file OpenVPN reads. For my solution see the living-example in the example folder.

Using TLS authentication

OpenVPN highly recommends using TLS authentication hardening, see GettingStartedwithOVPN.

This requires the use of a pre-shared key: If you want to use it, you will first need to generate a TLS authentication key and then upload it into vault:

$ openvpn --genkey --secret openvpn.key
$ vault kv put secret/ovpn key=@openvpn.key

In the above example we call the secret "ovpn" but you can call it anything you want, as long as it is a known value. The key must be placed into both the client and server configurations and must match. Edit both config templates to include a section as shown below:

{{ .TLSAuth }}

Now run vault-openvpn passing in the name of the secret that holds our key, e.g.

# for the server config
$ vault-openvpn --auto-revoke --ovpn-key secret/ovpn --pki-mountpoint luzifer_io server

# for the client config
$ vault-openvpn --auto-revoke --ovpn-key secret/ovpn --pki-mountpoint luzifer_io client

Pay attention when using a Vault KV v2 backend: You need to specify the path slighty different and use vault-openvpn v1.9.0 and above.

$ openvpn --genkey --secret openvpn.key
$ vault kv put secret/vault-openvpn/ovpn key=@openvpn.key

$ vault-openvpn --auto-revoke --ovpn-key secret/data/vault-openvpn/ovpn --pki-mountpoint luzifer_io client

Mind the additional /data added inside the key directly after the mount. This is required due to the differences in API methods between the KV v1 and v2 backends.

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
go (14,899
certificate (97
vault (79
openvpn (76
pki (30