tryb93 / pistrong

Simplified CA and device cert manager for strongSwan VPN

pistrong

Simplified CA and device cert manager for the strongSwan VPN

Overview

pistrong greatly simplifies installing and configuring the strongSwan VPN. Once installed, use pistrong to easily manage the strongSwan Certificate Authority (CA) and Certificates for remote user devices connecting to the VPN. pistrong fully supports the roadwarrior use case (users on devices), and can be used to create and manage certs for other uses, such as host-to-host tunnels.

pistrong includes complete installation, configuration, and management support for Raspbian/Debian distros. There is partial install/config support for openSuSE, Ubuntu, Debian, and Centos. pistrong is distro-independent, so can be used on any distro once strongSwan is properly installed and configured.

pistrong consists of two components:

• pistrong - Provides day-to-day CA and user Key/Cert management

• InstallPiStrong - Installs and configures strongSwan

The easiest way to install pistrong is to use the bash command:

curl -L https://raw.githubusercontent.com/gitbls/pistrong/master/EZPiStrongInstaller | bash

This will download pistrong and InstallPiStrong to /usr/local/bin, and then start InstallPiStrong all to fully install and configure strongSwan. See the section on InstallPiStrong below for distro-specific details.

If you'd prefer to not feed an unknown script directly into bash, you can issue the following commands on your local system:

curl -L https://raw.githubusercontent.com/gitbls/pistrong/master/pistrong -o /usr/local/bin/pistrong
curl -L https://raw.githubusercontent.com/gitbls/pistrong/master/InstallPiStrong -o /usr/local/bin/InstallPiStrong
chmod 755 /usr/local/bin/{pistrong,InstallPiStrong}
/usr/local/bin/InstallPiStrong all

pistrong

Once strongSwan has been installed and configured, pistrong creates the CA and manages users. pistrong provides commands to create (or delete) the CA, add, revoke, delete, or list users, and simple strongSwan service management (start, stop, restart, enable, disable, status).

If you have a webserver and email, pistrong can send email to the user with a link to the certificates, and a separate email with the password for the certificate.

Example commands

• pistrong createca --vpnsankey my.special.vpnsankey Create a new Certificate Authority using the vpnsankey as specified. The VPN SAN key is required and provides an extra level of security for iOS device authentication. See CertDetails.md for more information on VPN SAN keys.

• pistrong add fred --device iPhone --mail [email protected] --webdir /var/www/html/vpn --weburl http://myhost/vpn --random Add user fred, for the device named iPhone. Copy the necessary certs to webdir. Send fred email with links to the Certs using weburl. The device name is optional and may be helpful track where a Cert is targeted. If --device is not specified, dev is used. In general, you should have webdir, weburl, and random configured in ~/.pistrongrc rather than specifying them on the command line.

• pistrong resend fred-iPhone --mail [email protected] Resend the email with the links to the Certs to the specified email address.

• pistrong list fred --all [--full] List all Certs for user fred. Print the cert contents also if --full specified

• pistrong deleteca Delete the whole CA including all user Certs. You will be asked to confirm, since this is irreversible and will require that all issued Certs be replaced. Everything. Be really sure, especially if you have more than a couple of users.

• pistrong makevpncert --vpncert mynewcert --vpnsankey the.other.clients Create a new VPN Key and Cert with a different SAN key

• pistrong help Print detailed online help

InstallPiStrong

InstallPiStrong downloads the source and builds/installs the latest release of strongSwan. It also creates the strongSwan configuration and required config files for pistrong. The installation has been fully tested on Raspbian. Support for openSuSE, Ubuntu, Debian, and Centos is implemented but not fully end-to-end tested.

InstallPiStrong builds strongSwan from source rather than using the distro's strongSwan package since most distros are carrying older versions of strongSwan. Additionally, not all distros appear to have strongSwan built with --enable-systemd. pistrong only works with the new systemd model. The download/build/install process takes 15-20 minutes on a Raspberry Pi 3B.

InstallPiStrong has several phases. If no phase is specified or all is specified, all phases will be run. InstallPiStrong will pause at the start of each phase to provide time for reviewing the results of the previous phase. The phases include:

• prereq ensures that the required packages are installed on your system

• download downloads the latest strongSwan release

• preconf runs configure on the strongSwan source

• make compiles strongSwan

• install installs strongSwan into the system

• postconf or post-configure creates

  • /etc/swanctl/swanctl.conf strongSwan config file for iOS and Windows roadwarrior use
  • /etc/swanctl/pistrongdb.json pistrong CA database
  • ~/.pistrongrc pistrong config file for frequently-used settings rather than on the command line
  • Copies (in /etc/swanctl) of the just-created files swanctl.piStrongInstall, pistrongdb.piStrongInstall, and .pistrongrc.piStrongInstall

  Use InstallPiStrong postconf if you install strongSwan with some other mechanism and want to use pistrong to manage your CA and user/device Certs.

Hints

• Edit ~/.pistrongrc as needed. Strongly suggest random:true, as it simplifies the add user workflow, and adds additional protection to your certificates.

• For quick and dirty cert loading via the web (Raspbian example):

  • apt-get install apache2

  • mkdir /var/www/html/vpn

  • In ~/.pistrongrc:

    "webdir":"/var/www/html/vpn",
    "weburl":"http://hostname/vpn",
    "smtpserver":"ip address of smart smtp server",

  Note that the last configuration line in .pistrongrc (before the close brace) must not have a comma.

• If you need to use multiple strongSwan connections (for different users accessing different local subnets, for example), here is an outline of how to do this:

  • Establish the primary configuration with the desired CA Cert and VPN SAN key
  • Create a secondary CA and a VPN Cert/Key in that secondary CA
  • Manually edit /etc/swanctl/swanctl.conf and add the second connection using the secondary CA, VPN SAN Key, and secondary VPN Cert. Also add the secondary IP address pool.
  • When adding users, always specify --cacert and --remoteid to specify the secondary VPN SAN Key to ensure that the user Cert is assigned to the correct connction.
  • NOTE: If you ever re-create the CA using pistrong makeca you'll need to recreate the secondary Cert/Key and validate the connection in /etc/swanctl/swanctl.conf, so don't do that unless you're really sure!

• Email server configuration is beyond the scope of this document. However, if you install postfix (on a Raspberry Pi), take all the defaults, and select local mail delivery, pistrong will be able to send mail to local users, such as user pi.

Security considerations

For the most secure implementation, here are some things to consider:

• Always use an FQDN hostname (hostname.domain.com) for a registered domain. If you do not have a static IP address, use a dynamic DNS service. The FQDN hostname helps ensure that your client is connecting to a known host, and is the most reliable way to connect to your VPN from the internet.

• If you don't have an FQDN for the VPN server, you may need to use --vpnsankey yourExternalIPAddress when you create the CA.

• pistrong easily enables a one certificate for multiple devices, or a one certificate per device scenario. The former is a bit easier, the latter provides finer granularity access control.

Not Yet Completed

• Android and MacOS testing - Certificate install testing and documentation for these devices.

• Install on other distros - Additional popular distros should be added to InstallPiStrong

• More usage. Besides me, that is.

• Improved username/keyname validation. Checks are very minimal now, and effects of strange characters are unknown, but do not pose any known security risk.

If you're interested...

Please refer to the issues list if you have ideas for improving this tool or have found a problem, and if nobody else has mentioned it, I would be very happy to hear from you. There's always the possibility of a bug that I missed ;), or a great feature that should be added.

Or, if you're so inclined, do it yourself and leave a pull request.

Testing and documenting cert installation steps for Android and MacOS is another area where I would really apprecaite your help, in addition to adding support to InstallPiStrong for more Linux distros.