Chapter 15. Configuring VPN Server

15.1. Overview¶

This section introduces a brief overview of some scenarios which VPN offers, and some relevant terminology as well.

15.1.1. VPN Scenarios¶

There are many solutions to set up and build of a VPN connection. This chapter focuses on the OpenVPN package. Compared to other VPN software, OpenVPN can be operated in two modes:

Routed VPN

Routing is an easy solution to set up. It is more efficient and scales better than bridged VPN. Furthermore, it allows the user to tune MTU (Maximum Transfer Unit) to raise efficiency. However, in a heterogeneous environment NetBIOS broadcasts do not work if you do not have a Samba server on the gateway. If you need IPv6, each tun drivers on both ends must support this protocol explicitly.

Figure 15.1. Routed VPN¶

Bridged VPN

Bridging is a more complex solution. It is recommended when you need to browse Windows file shares across the VPN without setting up a Samba or WINS server. Bridged VPN is also needed if you want to use non-IP protocols (such as IPX) or applications relying on network broadcasts. However, it is less efficient than routed VPN. Another disadvantage is that it does not scale well.

Figure 15.2. Bridged VPN - Scenario 1¶

Figure 15.3. Bridged VPN - Scenario 2¶

Figure 15.4. Bridged VPN - Scenario 3¶

The major difference between bridging and routing is that a routed VPN cannot IP-broadcast while a bridged VPN can.

15.1.2. Tun and Tap Devices¶

Whenever you setup a VPN connection your IP packets are transferred over your secured tunnel. The connection between the client's device and the server's device is called a tunnel. A tunnel can use a so-called tun or tap device. They are virtual network kernel drivers which implement the transmission of ethernet frames or ip frames/packets:

tun device: A tun device simulates a point-to-point network (layer 3 packets in the OSI model such as Ethernet frames). A tun device is used with routing and works with IP frames.
tap device: A tap device simulates an ethernet device (layer 2 packets in the OSI model such as IP packets). A tap device is used for creating a network bridge. It works with Ethernet frames.

The userspace program OpenVPN can attach itself to a tun or tap device to receive packets sent by your OS. The program is also able to write packets to the device. For more information, see /usr/src/linux/Documentation/networking/tuntap.txt. You must install the kernel-source package to read this file.

15.2. Creating the Simplest VPN Example¶

The following example creates a point-to-point VPN tunnel. It demonstrates how to create a VPN tunnel between one client and a server. It is assumed that your VPN server will use private IP addresses like 192.168.1.120 and your client the IP address 192.168.2.110. You can modify these private IP addresses to your needs but make sure you select addresses which do not conflict with other IP addresses.

	Use It Only For Testing
This scenario is only useful for testing and is considered as an example to get familiar with VPN. Do not use this as a real world scenario to connect as it can compromise your security and the safety of your IT infrastructure!

15.2.1. Configuring the VPN Server¶

To configure a VPN server, proceed as follows:

Procedure 15.1. VPN Server Configuration¶

Install the package openvpn on the machine that will later become your VPN server.
Open a shell, become root and create the VPN secret key:
```
openvpn --genkey --secret /etc/openvpn/secret.key
```

Copy the secret key to your client:

scp /etc/openvpn/secret.key root@192.168.2.110:/etc/openvpn/

Create the file /etc/openvpn/server.conf with the following content:
```
dev tun
ifconfig 192.168.1.120 192.168.2.110
secret secret.key
```
If you use a firewall, start YaST and open UDP port 1194 (Security and Users+Firewall+Allowed Services.
Start the OpenVPN service as root:
```
rcopenvpn start
```

15.2.2. Configuring the VPN Client¶

To configure the VPN client, do the following:

Procedure 15.2. VPN Client Configuration

Install the package openvpn on your client VPN machine.
Create /etc/openvpn/client.conf with the following content:
```
remote IP_OF_SERVER
dev tun
ifconfig 192.168.2.110 192.168.1.120
secret secret.key
```
Replace the placeholder IP_OF_SERVER in the first line with either the domain name, or the public IP address of your server.
If you use a firewall, start YaST and open UDP port 1194 as described in Step 5 of Procedure 15.1, “VPN Server Configuration”.
Start the OpenVPN service as root:
```
rcopenvpn start
```

15.2.3. Testing the VPN Example¶

After the OpenVPN is successfully started, test if the tun device is available with the following command:

ifconfig tun0

To verify the VPN connection, use ping on both client and server to see if you can reach each other. Ping server from client:

ping -I tun0 192.168.1.120

Ping client from server:

ping -I tun0 192.168.2.110

15.3. Setting Up Your VPN Server Using Certificate Authority¶

The example shown in Section 15.2 is useful for testing, but not for daily work. This section explains how to build a VPN server that allows more than one connection at the same time. This is done with a public key infrastructure (PKI). A PKI consists of a pair of public and private keys for the server and each client and a master certificate authority (CA), which is used to sign every server and client certificate.

The general overview of this process involves the following steps explained in these sections:

15.3.1. Creating Certificates¶

Before a VPN connection gets established, the client must authenticate the server certificate. Conversely, the server must also authenticate the client certificate. This is called mutual authentication.

You can use two methods to create the respective certificates and keys:

Use the YaST CA module (see Chapter 16, Managing X.509 Certification), or
Use the scripts included with the openvpn package.

15.3.1.1. Generating Certificates with easy-rsa¶

The easy-rsa utilities use the openssl.cnf file stored under /usr/share/openvpn/easy-rsa/VER. In most cases you can leave this file as it is.

Procedure 15.3. Generate the Master CA And Key¶

Open a shell and become root.
Change the directory to /usr/share/openvpn/easy-rsa/VER/. Replace the placeholder VER with either 1.0 or 2.0, the current versions.
Copy the file vars to /etc/openvpn and set export EASY_RSA to /usr/share/openvpn/easy-rsa:
```
export EASY_RSA="/usr/share/openvpn/easy-rsa/VER"
```
In the vars file change the KEY_COUNTRY, KEY_PROVINCE, KEY_CITY, KEY_ORG, and KEY_EMAIL variables according to your needs.

Initialize the PKI:

source /etc/openvpn/vars && ./clean-all && ./build-ca

Enter the data required by the build-ca script. Usually you can take the defaults that you have set in Step 4. Additionally set Organizational Unit Name and Common Name that were not set previously.

Once done, the master certificate and key are saved as /usr/share/openvpn/easy-rsa/VER/keys/ca.*.

Procedure 15.4. Generate The Private Server Key¶

Change to the /usr/share/openvpn/easy-rsa/VER/ directory.
Run the following script:
```
./build-key-server server
```
The argument (here: server) is used for the private key filename.
Accept the default parameters, but fill server for the Common Name option.
Answer the next two questions (“Sign the certificate? [y/n]” and “1 out of 1 certificate requests certified, commit? [y/n]”) with y (yes).

Once done, the private server key is saved as /usr/share/openvpn/easy-rsa/VER/keys/server.*.

Procedure 15.5. Generate Certificates and Keys for a Client¶

Change to the /usr/share/openvpn/easy-rsa/VER/ directory. Replace the placeholder VER with either 1.0 or 2.0.
Create the key as in Step 2 of Procedure 15.4, “Generate The Private Server Key”:
```
./build-key client
```
Repeat the previous step for each client that is allowed to connect to the VPN server. Make sure you use a different name (other than “client”) and an appropriate Common Name, because this parameter has to be unique for each client.

Once done, the client certificate keys are saved as /usr/share/openvpn/easy-rsa/keys/client.* (depending on the name that you have given for the build-key command).

Procedure 15.6. Final Configuration Steps

Make sure your current working directory is /usr/share/openvpn/easy-rsa/VER/.
Create the Diffie-Hellman parameter:
```
./build-dh
```
Create the /etc/openvpn/ssl directory.

Copy the following files to /etc/openvpn/ssl:

cp keys/ca.{crt,key} keys/dh1024.pem keys/server.{crt,key} /etc/openvpn/ssl

Copy the client keys to the relevant client machine. You should have the files client.crt and client.key in the /etc/openvpn/ssl directory.

15.3.2. Configuring the Server¶

The configuration file is mostly a summary of /usr/share/doc/packages/openvpn/sample-config-files/server.conf without the comments and with some small changes concerning some paths.

Example 15.1. VPN Server Configuration File¶

# /etc/openvpn/server.conf
port 1194 
proto udp 
dev tun0 

# Security 
ca   ssl/ca.crt
cert ssl/server.crt
key  ssl/server.key
dh   ssl/dh1024.pem

server 192.168.1.120  255.255.255.0 
ifconfig-pool-persist /var/run/openvpn/ipp.txt 

# Privileges 
user nobody
group nobody

# Other configuration 
keepalive 10 120
comp-lzo
persist-key
persist-tun
status      /var/log/openvpn-status.log
log-append  /var/log/openvpn.log
verb 4

	The TCP/UDP port to which OpenVPN listens. You have to open up the port in the Firewall, see Chapter 14, Masquerading and Firewalls. The standard port for VPN is 1194, so in most cases you can leave that as it is.
	The protocol, either UDP or TCP.
	The tun or tap device, see Section 15.1.2, “Tun and Tap Devices” for the differences.
	The following lines contain the relative or absolute path to the root server CA certificate (`ca`), the root CA key (`cert`), the private server key (`key`) and the Diffie-Hellman parameters (`dh`). These were generated in Section 15.3.1, “Creating Certificates”.
	Supplies a VPN subnet. The server can be reached by `192.168.1.120`.
	Records a mapping of clients and its virtual IP address in the given file. Useful when the server goes down and (after the restart) the clients get their previously assigned IP address.
	For security reasons it is a good idea to run the OpenVPN daemon with reduced privileges. For this reason the group and user `nobody` is used.
	Several other configurations, see comment in the original configuration from `/usr/share/doc/packages/openvpn/sample-config-files`.

After this configuration, you can see log messages from your OpenVPN server under /var/log/openvpn.log. When you have started it for the first time, it should finish it with:

... Initialization Sequence Completed

If you do not see this message, check the log carefully. Usually OpenVPN gives you some hints what is wrong in your configuration file.

15.3.3. Configuring the Clients¶

The configuration file is mostly a summary from /usr/share/doc/packages/openvpn/sample-config-files/client.conf without the comments and with some small changes concerning some paths.

Example 15.2. VPN Client Configuration File

# /etc/openvpn/client.conf
client 
dev tun 
proto udp 
remote IP_OR_HOSTNAME 1194 
resolv-retry infinite
nobind

# Privileges 
user nobody
group nobody

# Try to preserve some state across restarts.
persist-key
persist-tun

# Security 
ca   ssl/ca.crt
cert ssl/client.crt
key  ssl/client.key

comp-lzo

	We must specify that this machine is a client.
	The network device. Both clients and server must use the same device.
	The protocol. Use the same settings as on the server.
	Replace the placeholder `IP_OR_HOSTNAME` with the respective hostname or IP address of your VPN server. After the hostname the port of the server is given. You can have multiple lines of `remote` entries pointing to different VPN servers. This is useful for load balancing between different VPN servers.
	For security reasons it is a good idea to run the OpenVPN daemon with reduced privileges. For this reason the group and user `nobody` is used.
	Contains the client files. For security reasons, it is better to have a separate file pair for each client.
	Turns compression on. Use it only when the server has this parameter switched on as well.

15.4. Changing Nameservers in VPN¶

If you need to change nameservers before or during your VPN session, use netconfig.

Use the following procedure to change a nameserver:

Procedure 15.7. Changing Nameservers¶

Open a shell and log in as root.

Create the file /etc/openvpn/client.up with the following contents:

/sbin/netconfig modify -i "${1}" -s openvpn <<EOT
DNSSEARCH='${domain}'
DNSSERVERS='${dns[*]}'
EOT

Start your VPN connection with rcopenvpn start.
Create the file /etc/openvpn/client.down with the following contents:
```
/sbin/netconfig remove -i "${1}" -s openvpn
```

Run netconfig and replace the line DNSSERVERS with your respective entry:

netconfig modify -i tun0 -s openvpn <<EOT
DNSSEARCH='mt-home.net'
DNSSERVERS='192.168.1.116' 
EOT

To check, if the entry has been successfully inserted into /etc/resolv.conf, execute:

grep -v ^# /etc/resolv.conf 
search mt-home.net mat-home.net
nameserver ...
nameserver ...
nameserver 192.168.1.116

To remove the DNS entry, execute:
```
netconfig remove -i tun0 -s openvpn
```

Find another example in /usr/share/doc/packages/openvpn/contrib/pull-resolv-conf/.

If you need to specify a ranking list of fallback services, use the NETCONFIG_DNS_RANKING variable in /etc/sysconfig/network/config. The default value is auto which resolves to:

+strongswan +openswan +racoon +openvpn -avahi

Preferred service names have the + prefix, fallback services the - prefix.

15.5. KDE- and GNOME Applets For Clients¶

The following sections describe the setup of OpenVPN connections with GNOME and KDE desktop tools.

15.5.1. KDE¶

To setup an OpenVPN connection in KDE4 that can be easily turned on or off, proceed as follows:

Make sure you have installed the NetworkManager-openvpn-kde4 package with all dependencies resolved.
Right-click on a widget of your panel and select Panel Options+Add Widgets....
Select Networks.
Right-click on the icon and choose Manage Connections.
Add a new VPN connection with Add+OpenVPN. A new window opens.
Choose the Connection Type between X.509 Certificates or X.509 With Password depending on what you have setup with your OpenVPN server.

Insert the necessary files into the respective text fields. From our example configuration these are:

CA file	`/etc/openvpn/ssl/ca.crt`
Certificate	`/etc/openvpn/ssl/client1.crt`
Key	`/etc/openvpn/ssl/client1.key`
Username	The user
Password	The password for the user

If you have not used the KDE Wallet System, you are asked if you want to configure it. Follow the steps in the wizard. After you have finished this step, you are reverted back to the Network Settings dialog.
Finish with Ok.
Enable the connection with your Network manager applet.

15.5.2. GNOME¶

To setup a OpenVPN connection in GNOME that can be easily turned on or off, proceed as follows:

Make sure you have installed the NetworkManager-openvpn-gnome package with all dependencies resolved.
Start the Network Connection Editor with +F2 and insert nm-connection-editor into the text field. A new window appears.
Select the VPN tab and click Add.
Choose the VPN connection type, in this case OpenVPN.
Choose the Authentication type. Select between Certificates (TLS) or Password with Certificates (TLS) depending on the setup of your OpenVPN server.

Insert the necessary files into the respective text fields. According to the example configuration, these are:

Username	The user (only available when you have selected Password with Certificates (TLS))
Password	The password for the user (only available when you have selected Password with Certificates (TLS))
User Certificate	`/etc/openvpn/ssl/client1.crt`
CA Certificate	`/etc/openvpn/ssl/ca.crt`
Private Key	`/etc/openvpn/ssl/client1.key`

Finish with Apply and Close.
Enable the connection with your Network Manager applet.

15.6. For More Information¶

For more information about VPN, visit:

http://www.openvpn.net: Homepage of VPN
/usr/share/doc/packages/openvpn/sample-config-files/: Examples of configuration files for different scenarios