OpenVPN SiteToSite

From SME Server



Maintainer

Current Maintainer: J-P Pialasse
Original Contributor: Daniel B. ; Firewall Services ; mailto:daniel@firewall-services.com

Version

Contrib 9:
Contrib 10:
smeserver-openvpn-s2s
The latest version of smeserver-openvpn-s2s is available in the SME repository, click on the version number(s) for more information.


Description

smeserver-openvpn-s2s lets you inter-connect several SME servers, and their local networks with secure VPN. It uses OpenVPN as backend, using either the simple shared secret method, or the stronger, but more complex TLS mechanism. It's well integrated in SME, providing a panel to configure most settings.

Installation

install the rpms sme8.x and sme9.x

yum --enablerepo=smecontribs install smeserver-openvpn-s2s
yum --enablerepo=smecontribs install smeserver-openvpn-s2s
expand-template /etc/rc.d/init.d/masq
/etc/init.d/masq restart
yum --enablerepo=smecontribs install smeserver-openvpn-s2s
expand-template /etc/rc.d/init.d/masq
/etc/init.d/masq restart

Configuration

This contrib lets you create as many servers and clients daemon as you want. A server can only be used by one client (it's not a one server for multiple clients solution), so if you want to connect several SME to one central server, you'll need to create several server daemon, binding on different ports. Once connected, OpenVPN makes no difference between client and server, we just need to define which endpoint will bind on a local port waiting for a connection of the remote endpoint.

Lets take a simple example. We manage two SME servers

  • SME1
    • Local network: 192.168.9.0/24 (192.168.9.1 being the address of the internal interface of SME1)
    • Public DNS domain name: sme1.domain.tld (resolves to the public IP of SME1)
  • SME2
    • Local network: 192.168.11.0/24 (192.168.11.1 being the address of the internal interface of SME2)
    • Public DNS domain name: sme2.domain.tld (resolves to the public IP of SME2)
Before the VPN inter-connection

Now, we want to connect both servers, so that the two private networks can see each other.

We will configure SME1 as a OpenVPN client and SME2 as an OpenVPN server. We'll use the shared secret method as it's easier to configure.

So, in SME1 server-manager, we'll have to add a new client (in OpenVPN Site to Site panel) and configure it like this:

Configure a new client daemon

Then, click on the next button, we'll have a page to configure the shared secret key. We can generate such keys using openvpn command (on your SME Server, or on another Linux box. To create a new key, type the following command on your shell:

openvpn --genkey --secret /dev/stdout

You can also generate a key from a Windows box like this:

C:\Program Files\OpenVPN\bin\openvpn.exe --genkey --secret secret.txt

Then, open the secret.txt file.

Now, copy the key in the page of the server-manager, like this:

Enter the secret key

Now, on SME2, we add a new server, and configure it like this:

Configure a new server daemon

On the next page, we have to enter the same key we've used on SME1

Here are the explanation of some settings:

  • Daemon ID: just a unique identifier for this connection.
  • Description: a human readable description (eg link between SME1 and SME2)
  • Status: you can disable a VPN connection if you want, but most of the time you'll want it enabled
  • Authentication mechanism: How both ends will authenticate. The easier solution is the Shared Key. You can also use TLS if you want, but it's usually for power users (you need to manage a PKI, you can use PHPki for this if you want)
  • HMAC: THis is part of the security of the data channel with the Cipher. Default is the insecure SHA1, we suggest you use SHA256 as a minimum. This setting should match on both the server and the client. You can get a list of available HMAC using this command:
openvpn --show-digests | egrep 'digest size' | awk {'print  $1'}
  • Cipher: The cipher used. The default is to use the insecure BlowFish algorithm, we suggest you use AES-128-CBC as a minimum. This setting should match on both the server and the client. You can get a list of available ciphers using this command:
openvpn --show-ciphers | egrep '^[A-Z]{2}' | awk {'print $1'}
  • Remote Host (available on client only): IP or FQDN of the remote peer
  • Remote Port (available on client only): port used by the remote server
  • Local Port (available on server only): port on which the OpenVPN server will bind, waiting for connection of the client. Remote Port on the client and Local Port on the server should be the same
  • Local Virtual IP: the IP used internally by OpenVPN. You should choose a IP outside of any local networks
  • Remote Virtual IP: the IP used internally by OpenVPN on the other side. Those two virtual IP should be reversed between the client and the server
Important.png Note:
You don't really need to remember the virtual IP, as once the connection is established, you'll use the internal IP to access the remote server through the VPN. You just need to choose two IP address which won't clash with any other local networks, then, just forget about it


  • SnatOutbound: can be enabled or disabled (default is enabled). When enabled, connections initiated by the server itself will be SNATed so they will appear to come from the internal IP. If disabled, connections from the server itself will have the virtual IP as source. (This is only available since 0.1-19).
  • Remote Networks: Enter in this field the networks reachable through the other end point. For example, on SME1, you'll enter the local networks of SME2: 192.168.11.0/255.255.255.0, on SME2, you'll enter the local network of SME1: 192.168.9.0/255.255.255.0
Important.png Note:
If your server is in serveronly mode, you'll have to add the same routes in the device which acts as the default gatway of your local network, using the IP of your SME Server as the gateway



Once both peers are configured, we'll get something like this:

After the VPN inter-connection

We are now able to ping hosts on the other side using their private IP.

Additional options

Some advanced settings are not available on the panel, but only with db commands:

  • LogLevel: if you want to increase the verbosity of a daemon (either client or server), you set the LogLevel property. Valid LogLevel values are numbers between 0 (no output except fatal errors) to 11 (really verbose)
  • Protocol: can be tcp or udp. The default is to use udp. You shouldn't change this setting unless you have good reason to do so. This setting should match on both the server and the client.
  • Compression: can be enabled or disabled. Toggle the internal compression used by OpenVPN. The default is enabled. This setting should match on both the server and the client
  • AllowInbound: can be yes or no (default to yes). If set to no, inbound connections from this VPN will be dropped. This is usefull if you wan't a one-way VPN only (eg 192.168.9.0/24 can reach 192.168.11.0/24, but not the other way). Obviously, this setting only makes sens if you enable it on either the server or the client, but not both.

If you use TLS as authentication mechanism, you can set some other properties:

  • RemoteCommonName: The connection will be accepted only if the remote endpoint has a valid certificate, with this common name
  • CheckCertificateUsage: can be enabled or disabled (default is disabled). If enabled, a server daemon will only accept the connection if the remote endpoint present a client certificate, and a client daemon will only accept the connection if the remote endpoint present a server certificate.
  • tlsVmin: This is the minimum TLS version accepted, unless you need to communicate with a very old server, you should not be using lower than 1.2 as it is insecure. Default is 1.2.
  • tlsCipherSuites13: This is the list of accepted ciphers for TLS v1.3 in order of presentation. Default is TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
  • tlsCipher12: This is the list of accepted ciphers for TLS v1.2 in order of presentation. Default is TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256

example:

db openvpn-s2s setprop sme1 LogLevel 5 Cipher AES-256-CBC Compression disabled
signal-event openvpn-s2s-update

Templates for all the daemon (client and server) are in /etc/e-smith/templates/etc/openvpn/s2s/openvpn-s2s.conf/ You can create custom templates in /etc/e-smith/templates-custom/etc/openvpn/s2s/openvpn-s2s.conf/, the change will affect all the daemons. If you want to add special options only for one particular daemon, you can create a special file. For example, you want to add special OpenVPN options for a daemon called myvpn (daemon ID), and these options are not available with DB properties. Just create a file /etc/openvpn/s2s/myvpn.conf.custom, and add your options here. It'll be automatically loaded on templates expansion. example:

echo "no-replay" > /etc/openvpn/s2s/myvpn.conf.custom
echo "reneg-sec 900" >> /etc/openvpn/s2s/myvpn.conf.custom
signal-event openvpn-s2s-update

Troubleshoot

If you have problems, you can check the logs of the OpenVPN processes in /var/log/openvpn-s2s/<Daemon ID>.log

Backup and Restore

You should backup the directories /etc/openvpn/s2s/priv and /etc/openvpn/s2s/pub because keys and certificates used by this contrib are stored there.

Uninstall

If you want to remove the contrib, just run:

yum remove smeserver-openvpn-s2s

You can then remove the directory /etc/openvpn/s2s if you really want to remove everything (including the private keys and certificates)

Source

The source for this contrib can be found in the smeserver CVS on sourceforge.

Workarounds and known issues

if you migrate from SME8 to SME9 and are not able to connect after correctly migrating your certificates, this might be related to not secure enough algorithm. CentOS 6.9 release notes state that "Support for insecure cryptographic protocols and algorithms has been dropped. This affects usage of MD5, SHA0, RC4 and DH parameters shorter than 1024 bits." Of course real solution would be to migrate all your certs to better algorithm.

workaround :

echo -e "LegacySigningMDs md2 md5\nMinimumDHBits 512\n" >> /etc/pki/tls/legacy-settings
service openvpn-s2s restart

Bugs

Please raise bugs under the SME-Contribs section in bugzilla and select the smeserver-openvpn-s2s component or use this link


IDProductVersionStatusSummary (3 tasks)
11516SME Contribs10.0rcRESOLVEDlogrotate warning
11504SME Contribs10.0rcCONFIRMEDNFR: allow individual connections handling with dedicated systemd unit
9718SME Contribs10.0rcCONFIRMEDDNS resolution problem

Changelog

Only released version in smecontrib are listed here.

smeserver-openvpn-s2s Changelog: SME 10 (smecontribs)
2021/04/01 Jean-Philippe Pialasse 0.2-13.sme
- fix permission on log dir [SME: 11516]
2021/03/31 Jean-Philippe Pialasse 0.2-12.sme
- fix typos [SME: 11498]

2021/03/30 Jean-Philippe Pialasse 0.2-11.sme
- enforce better cipher with settings [SME: 11498]
- enforce better HMAC with setting [SME: 11498]
- enforce TLS 1.2 or better with setting [SME: 11498]
- enforce strong TLS ciphers with setting [SME: 11498]
- better list of vpn connections [SME: 11337]
- allow soft reload of individual connection [SME: 11337]

- fix incorect permission on private keys [SME: 11337]

2021/02/04 Brian Read 0.2-9.sme
- Initial import to SME10 [SME: 11337]

- Alter-for-systemd-startup
2017/12/02 SME Translation Server 0.2-8.sme
- apply locale 2017-12-02 patch
smeserver-openvpn-s2s Changelog: SME 9 (smecontribs)
2017/12/02 SME Translation Server 0.2-8.sme
- apply locale 2017-12-02 patch
2017/10/25 Daniel Berteaud 0.2-7.sme
- Fix daemon ID validation [SME: 10446]
2016/02/08 Daniel Berteaud 0.2-6.sme
- Create /etc/openvpn/s2s/dev/urandom [SME: 9238]
2015/07/01 stephane de Labrusse 0.2-5.sme
- Apply smeserver-openvpn-s2s-0.2-locale-2015-07-01.patch [SME: 8967]
2015/02/17 Daniel Berteaud 0.2-4.sme
- Apply locale 2015-02-17 patch


Other articles in this category

Ipsec, Smeserver-libreswan-xl2tpd, OpenVPN Routed, OpenVPN, VPN, OpenVPN Bridge, Libreswan, OpenVPN SiteToSite, Libreswan IPSEC, OpenVPN Bridge/fr, SME Server wishlist, SoftEther VPN, Softethervpn-server