Setting up an EdgeRouter Lite for an On Demand iOS VPN

Ever since I started my career, I've used Virtual Private Networks (VPN) to connect to a company network. My first experience is with AppleTalk Remote Access and I thought it was neat to be able to have my home computer on the work network. Over my career, I've used VPNs mostly as a user as I had no use for one as a home user.

When I setup cameras at my house over 3 years ago, I wanted to remotely connect to the cameras. Since I put together my own system, there wasn't an out of the box way to view the cameras (it does have a web interface, but I didn't want to directly expose that to the world). This gave me the first experience in setting up a VPN. I turned on Mac OS X Server's VPN, configured my iOS devices for the VPN and I was easily able to connect.

Recently I've been working with mobile device management (MDM) and one of the features that I've been reading about is on-demand VPN. I became curious about it and wanted to see if I could set it up more of an exercise than anything else, but also it would be useful to hop on any WiFi network and automatically connect to my home network. The iOS on-demand VPN requires that the VPN use certificate authentication instead of just a username and password. Unfortunately, the OS X Server's L2TP IPSec VPN doesn't support certificates, so I had to look to other options. Luckily, my EdgeRouter Lite can be configured as an OpenVPN server with certificate authentication. Given that, the only obstacle to setting this up was time and some futzing to get things right. I've scoured the web and managed to find the pieces to get things working.

The rest of this entry will document how to setup the server as well as the iOS client side. For the server setup, I followed this article, but had to make a few changes to get things to work the way I wanted. I then used another article to setup the iOS side.

This is a really long setup, but it is straightforward. If you're intimidated by command lines and editing text files, this process is not for you!

Certificate Setup

1. SSH into the EdgeRouter Lite
2. Setup a new certificate authority that will be used to create new client certificates for the VPN. Issue the following commands, one per line. Follow the prompts when you run the commands.

   configure
   sudo su
   cd /usr/lib/ssl/misc/
   ./CA.sh -newca
   

3. Create a new server certificate and sign it. Follow the prompts when you run the commands; you'll need to enter a password for the new request. We'll remove it in another step.

   ./CA.sh -newreq
   ./CA.sh -sign
   

4. Copy the certificate authority key and certificate to an area of the router that will survive a firmware upgrade.

   cp demoCA/cacert.pem demoCA/private/cakey.pem /config/auth/
   

5. Also copy the server certificate to the same place.

   mv newcert.pem /config/auth/server.pem
   

6. Display the certificate authority certificate using cat /config/auth/cacert.pem and then copy it into BBEdit or another text editor on your local computer; save it to your hard drive.

7. Remove the password on the private key for the server so that the VPN server can start automatically.

   openssl pkcs8 -in newkey.pem -out /config/auth/server-pem.key
   

8. Generate the Diffie-Hellman Paramters; this takes a long time.

   openssl dhparam -out /config/auth/dhp.pem -2 1024
   cp dhp.pem /config/auth
   

9. The next part is generating the client certificates. The recommendation is to have 1 client certificate per client. However, this would require me to have 1 for my iPad and 1 for my iPhone complicating setup. While having 1 certificate for both may not be recommended, it is the route I chose. When prompted, enter a password for the new key and then the last line will remove it. Don't enter a challenge password.

   ./CA.sh -newreq
   ./CA.sh -sign
   mv newcert.pem client-cert.pem
   openssl pkcs8 -in newkey.pem -out client-key.pem
   

10. Display the certificate using cat client-cert.pem and past it into BBEdit and then saved it.

11. Do the same thing with the key using cat client-key.pem and saved it to my Mac.

12. On my Mac, do the following in Terminal (make sure you're in the same directory as where you saved the certificate and key). When exporting, set a password that you'll use later.

    openssl pkcs12 -export -out client1.p12 -inkey client-key.pem  -in client-cert.pem
    

OpenVPN Server Setup

1. SSH into the EdgeRouter Lite if you haven't already.
2. Exit out of sudo mode using exit if you're still using the same session as before.
3. Enter configuration mode:

   configure
   

4. Start editing the VPN tunnel (I didn't know that by entering a full path to an object, you didn't have to enter a full command for subsequent items):

   edit interfaces openvpn vtun0
   

5. Setup the server.

   set mode server
   set local-port 1194
   

6. Select a subnet. Choose a subnet that doesn't overlap with other subnets on your LAN. Notes have also indicated that you should pick an IP range that isn't used on other networks as you could have routing problems, but I'm not completely positive that is true. If you're routing everything over the VPN, the device should use that route first.

   set server subnet 10.0.20.0/24
   

7. Configure the TLS parameters

   set tls ca-cert-file /config/auth/cacert.pem
   set tls cert-file /config/auth/server.pem
   set tls key-file /config/auth/server-pem.key
   set tls dh-file /config/auth/dhp.pem
   

8. The notes indicate for EdgeMax 1.8 firmware and higher, you can turn on IPv6 support. I'm not running that, yet, so I didn't do this.

   set protocol udp6
   

9. For my purposes, I want all the traffic to go over the VPN. I'm not sure if the second line is strictly needed.

   set openvpn-option "--push redirect-gateway"
   set server push-route 10.0.1.0/24
   

10. Since I run Pi-hole for blacklisting advertising, I want to continue to do that even when connected to my VPN. (Yes, I know websites make money off the ads, but the ads really need to get better and more relevant before I'll turn this off.) I set my DNS to the same entries that I set on the EdgeRouter's DHCP server.

    set openvpn-option "--push dhcp-option DNS 10.0.1.2"
    set openvpn-option "--push dhcp-option DNS 10.0.1.1"
    

11. Now a few extra OpenVPN options. I allow the same certificate to be used by multiple clients, so I have that option as well as one to enable compression.

    set openvpn-option --comp-lzo
    set openvpn-option --duplicate-cn
    

12. Next up are the firewall rules to allow clients to connect from the outside to the EdgeRouter Lite.

    top
    edit firewall name WAN_LOCAL 
    set rule 4 action accept
    set rule 4 description “OpenVPN”
    set rule 4 destination port 1194
    set rule 4 protocol tcp_udp
    set rule 4 log disable
    

13. If you have an IPv6 firewall, you might add something like this.

    top
    edit firewall name WANv6_LOCAL 
    set rule 4 action accept
    set rule 4 description “OpenVPN”
    set rule 4 destination port 1194
    set rule 4 protocol tcp_udp
    set rule 4 log disable
    

14. That's it for the server setup! Finally do:

    commit
    save
    exit
    

15. Check that the OpenVPN server is running using:

    ps -ef | grep openvpn
    show openvpn server status
    

The last line can be used when clients are connected to monitor it.

Good work if you've followed along this far! Next up is the client setup which has a bunch of steps as well.

iOS Client Setup

1. Locate the p12 file that you created on your Mac.
2. Download Apple Configurator from the Mac App Store.
3. Select New Profile from the File menu.
   
   

4. Fill out the General information for the profile. You can leave the Identifier as is.
   
   
   

5. Click on Certificates and then press Configure. Select the .p12 file you created way back in the first part of the instructions.
   
6. Give the certificate a name and enter the password you used when exporting the p12 file.
   

7. Select the VPN section and click Configure.
   

8. Enter a name for the connection.

9. Select Custom SSL for the Connection Type.
10. Enter net.openvpn.OpenVPN-Connect.vpnplugin for Identifier.
11. Enter the hostname for the Server. I recommend your Dynamic DNS hostname here. I wouldn't recommend a CNAME as I'll explain later.
12. Enter some username for the account; it won't be used.
13. Enter a placeholder key/value pair. You'll edit this by hand later.
14. Select Certificate for User Authentication and then pick the certificate you added earlier.
15. Enable VPN On Demand. You'll hand edit this later as well.
16. Select a Disconnect on Idle value; I selected Never.
17. Save the profile to your Desktop (or somewhere else). Don't sign it as signing it will prevent you from editing it by hand which is needed to properly setup the VPN On Demand. Configurator doesn't handle all the options present in current iOS versions.
    
18. Open the .mobileconfig file in BBEdit. BTW, if you haven't bought BBEdit, you should definitely buy it. While the current version offers basic functionality for free, this is a tool that should always remain in your tool belt.

19. Look at the section called VPN. Mine is basically below. You'll need to change a few entries.

        VPN
        
            AuthName
            scott
            AuthenticationMethod
            Certificate
            DisconnectOnIdle
            0
            OnDemandEnabled
            1
            OnDemandRules
            
                
                    Action
                    Disconnect
                    SSIDMatch
                    
                        My Network 5 GHz
                        My Network
                    
                
                
                    Action
                    Disconnect
                    InterfaceTypeMatch
                    Cellular
                
                
                    Action
                    Connect
                    InterfaceTypeMatch
                    WiFi
                
                
                    Action
                    Ignore
                
            
            PayloadCertificateUUID
            SOME_IDENTIFER_REPLACE_WITH_WHAT_YOU_HAVE
            RemoteAddress
            vpn.example.com
        
        VPNSubType
        net.openvpn.OpenVPN-Connect.vpnplugin
        VPNType
        VPN
        VendorConfig
        
            dev
            tun
            proto
            udp
            remote
            vpn.example.com 1194
            cipher
            BF-CBC
            resolv-retry
            infinite
            nobind
            NOARGS
            persist-key
            NOARGS
            persist-tun
            NOARGS
            comp-lzo
            NOARGS
            link-mtu
            1542
            ca
            -----BEGIN CERTIFICATE-----\nMIID...bAqZZCQYgHwAh9bW\n-----END CERTIFICATE-----\n
            cert
            -----BEGIN CERTIFICATE-----\nMIID...1jCCAr6gAwIBAgIBC\n-----END CERTIFICATE-----\n
            key
            -----BEGIN RSA PRIVATE KEY——\nMIIG4wIBAAKCAYEA...psUtuM+qAfu\n-----END RSA PRIVATE KEY-----\n
        
    
    

20. Change the PayloadCertificateUUID to whatever is already in your config file.

21. Change the vpn.example.com references to your VPN address.
22. For the section that starts with BEGIN CERTIFICATE for the ca, find the cacert.pem that you saved to your hard drive. Open that in BBEdit and remove all the returns in the file. After the first line replace the return with \n. Before the last line put a \n and then another one after the line. You should end up with a big long line!
23. For the cert, repeat the above using the client-cert.pem from earlier.
24. For the key, repeat the above using the client-key.pem from earlier.
25. The OnDemandRules are described in Apple's documentation. My setup basically says that if I'm on a trusted network, disconnect the VPN. When on cellular, also disconnect the VPN (I trust the cellular network for now). If I'm on any other network, connect the VPN. The last item just falls through, but I suspect it will never get there. In my example, change the names of the trusted SSIDs.
26. The VendorConfig section are the OpenVPN options that should match the server.
27. Save the file.
28. Transfer the .mobileconfig file to your iOS device. I drop the file on AirDrop to my devices. If the formatting of the file is correct, the iOS device will ask you to install the file.
29. In the VPN section in iOS Settings, Connect and cross your fingers. That's it! Now when you wonder onto an unknown WiFi network, the VPN should automatically connect. It may take a few seconds for the connection to come up.

If you've made it this far, congratulations! I spent a few days working on this and hopefully I captured all the steps. Please send me corrections or feedback.

Notes

1. I mentioned earlier that a CNAME entry for my VPN server caused a problem and that is because if I'm connecting from inside my firewall (yes, I know it isn't needed), the client tries to go to the external IP address. By using an A DNS entry and doing the following on the EdgeRouter Lite:

   configure
   set system static-host-mapping host-name vpn.example.com inet 10.0.1.1
   commit
   save    
   

   You can have your client connect to the VPN from inside the firewall. This is useful if iOS gets confused and wants to connect to the VPN when it shouldn't.

2. I've noticed that sometimes iOS connects to my VPN even when it is on my network. The On Demand connection is evaluated when the network changes and I suspect iOS gets confused and starts evaluating the On Demand rules prior to getting an SSID. This isn't a big deal as my clients can connect to the VPN even on my own network.

3. The default certificates are good for 1 year. So you'll need to renew then after a year. I'll cross that bridge when I come to it.
4. If the certificate is compromised, I don't know how to do certificate revocations.
5. Treat the certificate and keys just as if they were passwords. This goes for the .mobileconfig file as well. The mobileconfig file has the password to the p12 file in clear text and anyone with that file can connect to your VPN and access your network.
6. The OnDemand rules are evaluated when the device changes networks and may take a few seconds to bring up the VPN. I always wait for the VPN icon to come up before doing anything on my device.
7. OpenVPN runs on UDP port 1194 by default. You can configure it for TCP 443, but I won't go into that because it seems like a pain and requires more changes.