A second version of RaspberryPi OS has been available since December 2019. Preliminary tests have shown that, much like its predecessor, this updated version of Raspbian from the Raspberry Pi Foundation brings nothing much that is new insofar as installing and using the virtual private network software WireGuard is concerned. As far as I can tell the pertinent changes are
- The OS image is now delivered with version 5.4 of the Linux kernel. Previously, the image had the 5.19 kernel which was bumped up to 5.4 on the first upgrade of the system.
- The Linux kernel headers are included in the image. Previously, they had to be obtained before proceeding with the WireGuard installation.
Consquently, there is one less step required in the installation process. Configuration of the "server" on the Raspberry Pi and installation and configuration of "clients" on tablets or "peers" on other computers remains unchanged. Accordingly this post is a verbatim copy of the previous August 2019 post except for the simpler installation of WireGuard in the first part. In the following description, the package is installed on a Raspberry Pi Model B Rev 2 only. This older, circa 2012, Pi is based on the Broadcom BCM2825 system on chip (SoC) which has a single core ARM CPU with an ARMv6 architecture. Although it is an old model 1 Pi, it resembles the current Pi Zero models except for a slower frequency. Previous experience showed that there may be slight differences if using a new model, but that these are limited to slightly different number of updated or installed packages and slightly different size of updated packages.
Please refresh this page whenever you come back to this topic. It was probably an error but I have been reusing the
https://sigmdel.ca/michel/ha/wireguard/wireguard_02_en.html URL for new versions. I was hoping that search engines would serve up the most recent version, but browsers may display an old cached version which altogether defeats my goal.
Table of Contents
- Installing WireGuard
- Enabling Remote Access to the Local Network
- Configuring WireGuard
- Installing the Adrian Mihalko User Management Script
- Generating the Private and Public Server Keys
- Creating and Editing the Server Definition File
- Editing the Client Configuration Template
- Editing the Server Configuration Template
- Creating an Empty WireGuard Server Configuration File
- Managing the WireGuard Service
- Managing Users
- Using the WireGuard VPN Clients
- Concluding Remarks
WireGuard is quickly growing in popularity. Linus Torvalds has followed through on earlier positive comments about the package and pulled the WireGuard VPN into the Linux 5.6 kernel source tree. While Ubuntu 20.04 uses the 5.4 kernel, it comes with WireGuard installed. With its typically cautious approach, Debian has not yet integrated the package, but it is slated to be included in the upcoming release of
Bullseye destined to replace
Buster. Raspberry Pi OS is based on the Debian distribution, also using the 5.4 kernel and it does not yet include WireGuard. Clearly, this could change in the near future so it makes sense to check that WireGuard is not already present. Try the following commands.
If the two programs are found (probably in
/usr/bin/), WireGuard is installed. Just verify that it is correctly in place, and then go on to configure WireGuard.
The current version of Raspberry Pi operating system
Raspberry Pi OS Lite Release date: December 2nd 2020 Kernel version: 5.4 Size: 438MB
can be downloaded from the Operating system images
page. There are three versions of the OS, the
Lite version is typically chosen if the Raspberry Pi is used as a server, while one of the "desktop" versions with a graphical user interface (GUI) should be obtained if the Pi is to be used as a full-fledged desktop computer with connected keyboard and monitor. Even if a GUI version is installed, it will be probably be necessary to open a terminal to install WireGuard.
If using a newly copied image of the OS, do not forget to use the
raspi-config utility to change, at a minimum, the system password, hostname, and time zone. On a server it is probably best to ensure that SSH is enabled and to allocate as little memory as possible (16 Mb) to the graphic processor. There are numerous descriptions on how to proceed on the Web or even on my site, so there's no point in describing that process yet again.
In what follows, the hostname of the model 1 Raspberry Pi is
Exactly which packages will be upgraded and the disk space freed or used will depend on how long it has been since the last upgrade was done. Note that unlike in the upgrade of the first version of Raspberry Pi OS, the kernel version remained unchanged at 5.4.79. I checked and WireGuard had not sneeked in.
However the kernel headers were in place. This time I checked using the package manager and also ensured that the versions of the kernel and the kernel headers matched.
So it is now possible to proceed with the installation of WireGuard with worying about that prerequisite. If an older version of the OS is being used, the prerequiste must added (see: Installing and Configuring WireGuard on Raspberry Pi OS (August 2020)).
For the impatient here are the four commands that will add the
testing Rasbian repository with the least impact and will install WireGuard.
If you want to know a bit more about the reason for these commands, read the rest of this section.
There is no doubt that WireGuard is not present in the updated Raspberry Pi OS Lite image and the package is not available in the stable Raspbian repositories.
Here is the list of all the repositories that the
apt utility searched when looking for the WireGuard package without success.
Luckily, the desired packages are available in the Raspbian
testing repository. Many thanks to Daniel T. Wagner for pointing that out and providing these instructions for installing the package in a private e-mail on July 27. Thanks also to Aravind Reddy for helpful comments and corrections.
Since I did not want all 383 packages of the current stable distribution replaced by versions from the testing repository, I lowered the priority of the packages in the testing depot, and then checked the priority of all used depots and verified that no stable package would be replaced with packages from the testing repository on the next
The following shows that the desired packages are available in the
testing repository which is now reachable.
wireguard package is a "metapackage" whose purpose is to install
When doing this with newer Raspberry Pi models the output will be slightly different but the end result will be the same.
It is now possible to verify that the WireGuard utilities have been installed.
To further test the installation, let's create an empty interface configuration file and bring up the interface.
Verification shows that the WireGuard module was loaded and the network interface is created and that the server is up and waiting for incoming UDP packets on port 40213. The port may be different, because it is chosen randomly as far as I can make out.
However, it is rather pointless to bring up the interface because it will not do anything without proper configuration. Taking the interface down and stopping the server is just as easy, but note how the WireGuard module remains loaded.
Hopefully, the home local area network is not easily accessed from outside the LAN because that would mean that it is vulnerable to attacks from any bored script kiddie out there in the nasty world. However, easy yet secure access to the local network from anywhere on the Internet is possible when hosting WireGuard or another virtual private network server on the home network. The server is not the only element that needs to be in place for remote access. This section examines other prerequisites.
If you already have access to an IP camera, a home automation system or a self hosted cloud or NAS then you are probably quite familiar with dynamic host names and port forwarding so that you can skim through the next three steps, but do read carefully about Enabling IP forwarding.
How could one even hope to set up a virtual private network if the server does not have a fixed address? This is especially true for WireGuard which is "very quiet" as explained later. So the Raspberry Pi hosting the WireGuard server must have a fixed IP address on the local network. Many recommend adding a "DHCP Reservation" for the Pi in the router static IP address table. Each router is different, but essentially the desired IP address is given along with the Raspberry Pi MAC address which the DHCP server on the router uses to identify the Pi when it is time to assign IP addresses to devices on the LAN. If this is done, then it's a good idea to choose a static IP address outside the range of dynamic DHCP addresses. Most routers let the user specify that range.
To display the MAC address of the network interfaces use the
and search for the
ether entry under each interface. By default the Ethernet interface is named
eth0 and the Wi-Fi interface is named
wlan0. The information is also buried in the system directory.
Of course, on older Pi models there will not be a Wi-Fi interface unless some hardware such as a Wi-Fi USB dongle has been added.
The static IP address table of my router holds a rather limited number of entries. And sometimes I think that its non-volatile memory is less reliable than the SD cards I use with the Raspberry Pi. Consequently, I let the DHCP client of the Raspberry Pi set up a static IP address for the Wi-Fi and Ethernet interfaces instead of getting a dynamic address from the router. This is done by adding the needed information at the end of the configuration file.
Of course this is the settings for a newer Pi with built-in Wi-Fi. On the old model 1 Pi, there is no
On my router, the Raspberry Pi shows up as a connected device with a "self-assigned" IP address. Again, the static IP address assigned to the Pi should be outside the pool of dynamic DHCP addresses controlled by the DHCP server on the router. For some important devices such as the Raspberry Pi that hosts my home automation system, I chose to set a static IP address with a DHCP reservation on the router and have the Raspberry Pi set up a static IP address, just to be safe.
All the computers and devices connected to your home network (often called LAN for Local Area Network) are assigned an IP address by the DHCP server which is probably the router provided by your Internet Service Provider (ISP). On my system the router has
192.168.1.1 for an IP address and the Raspberry Pi hosting the VPN server has a fixed IP address:
192.168.1.22. If you think about it, there are many thousands of devices spread around the globe with that particular address. There is no hope that my Raspberry Pi can be reached from outside the LAN using
192.168.1.22 as the destination address. That problem has been solved with clever routing algorithms. All my devices connected to the local network send their traffic to the router at
192.168.1.1 when receiving or sending data to sites on the Internet. The router then passes each packet on to the ISP, changing the source IP address from say
192.168.1.22 to a public IP address assigned to my network by the ISP. That assigned public IP is unique on the whole of the Internet so that sites that receive packets from devices on my LAN, can reliably reply using as the destination IP the public IP address assigned by my ISP. When the router receives these packets of data, it routes them to the appropriate device on the LAN. There's obviously a little bit of magic going on to keep track of which device gets which packets as they come in, but that's another story. The point is that to talk to my Raspberry Pi from outside the LAN, the public IP address assigned by the ISP must be known. That's not difficult to find. Usually the router with the outside connection to the Internet shows that information.
In addition, there are plenty of sites on the Web that will display your public IP address.
If only it were that simple. Unfortunately, the public IP address cannot be trusted because it is dynamically assigned by the ISP and may change from time to time. Any DHCP server can force a client to reconnect at any time and change the assigned IP at that point. Also, when one logs off a network, the DHCP server will reserve the assigned IP for a certain "lease" time should the client connect again. After the lease time is expired, the IP address is returned to the pool of available addresses that the DHCP server can assign to any new client. I have no idea just how long lease time is but it is not very short. Furthermore, devices like smart speakers and phones seem to be calling the mothership often enough to restart the lease so that I sometimes have the same public IP address for days on end. For the duration of this post, let's say that my sticky dynamic public IP address is
22.214.171.124. Indeed, I could get away with using
126.96.36.199 as the public IP address of my network for testing the WireGuard configuration later on.
In practice though, one should avoid using a dynamic IP address. Instead the local network should be reached through a dynamic host name. DNS is the domain name system which translates the name of a website such as
www.google.com into an IP address (
188.8.131.52). Some sites offer a service, often free, that associates a domain name with an IP address. These sites update the IP addresses in their database at regular intervals. So, we will put in the HTML request the domain name obtained from the DNS service. The DNS will translate this name into an IP address that will be updated each time the ISP assigns a different IP address to the home server. There are plenty of sites on the Web that describe how to set up a dynamic domain name with any one of a number of DDNS providers and among them there is a description of how I did it using freedns.afraid.org back in 2018. So get yourself a dynamic host name, and learn how to signal any change in the public IP address assigned to your network to the DDNS service.
In what follows, my dynamic host name is deemed to be
modomo.twilightparadox.com, which I hope is a fictitious name.
Part of the magic behind the routing of data packets across the router is that each packet must be sent through a "port". Ports are not physical entities, they are more like an apartment number added to a street address to ensure that a letter gets to the proper mail box. In the jargon, they are "end points" of a communication link and must be tacked on at the end of an IP address or host name. As an example, FTP control packets sent from the desktop computer to the Raspberry Pi, have as a destination address
192.168.1.22:21. Some port numbers are implicit. All HTTP traffic is usually sent to port 80, while HTTPS traffic is sent to port 443. Try
https://www.google.com:9090 in a browser. This will send the request to port 9090, which is specified after the colon. The search engine does not "listen" to that port, so nothing will be displayed unless you are very patient and then some sort of error message may appear. Try
https://www.google.com:443 and you will see the familiar search page very quickly, but you don't have to write the port number, it is implicit the HTTPS protocol.
For security reasons, consumer class routers such as the one supplied by an ISP have a built-in firewall that controls incoming and outgoing network traffic. Typically, outgoing traffic can only be sent out if the end point (i.e. port) is for some "well known" use. Typically, incoming traffic is blocked outright unless it is part of an exchange initiated by a device on the LAN. That is why you can use a Web browser from your home computer to read this post! There's an obvious problem for us. How can the Raspberry Pi be reached if the firewall will not let through IP packets destined to the Pi. So a "hole" has to be punched through the firewall. In technical terms, a port forwarding rule has to be established. That rule will instruct the firewall to send any IP packet addressed to the correct port to be sent on to a Pi.
OpenVPN which is a very popular VPN package uses a default destination port, 1194 to be precise, although that can be changed. Furthermore, whichever port OpenVPN uses, it will identify itself when queried with a port scanner. WireGuard does not have a default port nor will it reply if the port it does use is probed. That means that when configuring WireGuard later on, you will have to choose a port number. The latter are 16 bit integers, which means they have a range from 0 to 65435. However, choosing a number between 0 and 1023 is generally a bad idea. Typically, tutorials on the installation of WireGuard use relatively big numbers such as 53133 which are in the dynamic, private or ephemeral range.
It is difficult to give instructions about implementing port forwarding because each router model is different. On mine, there is a
Port Forwarding tab in the
Basic menu, and a button which displays the window shown below when clicked.
As can be seen the router wants to forward a range of ports, so I specified a range of one port. I used the same port number for the public (Internet facing) port and for the private (local network) port. The latter will be appended to the local IP address,
192.168.1.22. In my case, all IP traffic sent to
modomo.twilightparadox.com:53133 will end up at the outward facing edge of my router as traffic sent to
184.108.40.206:53133. The router will then pass it over to the local network as traffic bound for
192.168.1.22:53133. If everything is set up correctly, WireGuard will know what to do with it.
If you are having trouble setting up the port forwarding rules on your router, there are sites such as PF Network Utilities that have information about many router models. They also offer utilities that perform various functions including port forwarding, which I cannot endorse because I am much too paranoid to install such software and much too cheap to pay for it in the first place. I must say that the site provided accurate information about my router, but it was hidden behind a lot of advertising for their products.
If access to other LAN resources such as an IP camera or a Web server is needed, then IP forwarding has to be enabled on the computer hosting the WireGuard server. If you do not enable IP forwarding, you will not be taking full advantage of the virtual private network. I repeat, skipping IP forwarding only makes sense if the only device that needs to be reached from outside with the VPN is the WireGuard host machine.
/etc/sysctl.d/99-sysctl.conf is a symbolic link
/etc/sysctl.conf. It will suffice to edit the later to enable
IP packet forwarding.
as instructed in the configuration.file. A reboot will be necessary for the change to take effect.
Configuring WireGuard is probably the most complicated part of setting up the VPN. There are many tutorials on how to proceed, starting with the WireGuard Quick Start guide. Frankly, I could not make much of it, because I really did not and still do not know enough to configure network interfaces, ip routing and so on from the command line. I did find other resources on the Web that helped me gain some knowledge, but in the end I have found that Adrian Mihalko, who provided the instructions for installing WireGuard on the Raspberry Pi, also created a user management script that perfectly suited my needs and level of understanding. I wanted a VPN server on the home network and VPN clients on Android devices (could be iOS) and this is precisely what the script facilitates.
The instructions below are very detailed, perhaps too much so. I would suggest that you read User management with Wireguard User Management Script written by Adian Milhalko and return here for more information if needed.
It may be useful to raise a little point here. WireGuard operates a peer-to-peer network. However it is sometimes useful to look at it as a client-server model, such as here where the WireGuard peer running on the Raspberry Pi is viewed as a server and the WireGuard peers on various Android devices are viewed as clients. In the end, peer, server, client and user are all the same thing. Hopefully that will not be a source of confusion.
There is one prerequisite to install that will be used to generate QR-code images that will make it very easy to configure a WireGuard client on an Android or iOS device.
Next we download an archive containing the script and supporting files and extract its content to a directory that will be called
I chose to create a
~/downloads directory and to moving the script archive in it with a more meaningful name, but it would have been fine to just delete the archive.
qrencodeand then cloning the repository containing the script.
The following list of steps might look daunting; it is actually rather easy to configure the WireGuard server and to add clients or peers with the script.
WireGuard encrypts the data exchanged over the virtual network. Much like SSH, asymmetric encryption is used to set up the secure session. Both server and client (or peers actually) have private and public keys, but only the latter are exchanged for authentication. Again, like SSH, the private keys have to be shared "out-of-band" beforehand. In this case that means that the keys must be manually copied to each peer configuration file. There is no third party "certificate authority" for SSL certificates as in the HTTPS or OpenVPN protocols.
The first step, which is done only once, is to generate the private and public keys of the WireGuard server on the Raspberry Pi.
If the command seems a bit opaque to you as it did to me, here is what it actually translates to:
These two keys are needed in the next steps. Copy them into a text editor on the desktop or open a second SSH session on the Raspberry Pi for easy access to the keys later.
Normally, one never makes the private key public. So the keys shown above are only for demonstration purposes, and you must replace those values with the one actually generated.
This step, performed once only, creates the
wg.def file which contains data the script will use to make the server configuration and client configuration files.
This is the template.
And this is how I changed it.
192.168.99.xxx is used on the local area network, then the value of
_VPN_NET will need to be changed. The
_SERVER_PORT is the
UDP port that will
have to be forwarded to the WireGuard sever by the LAN router or gateway.
This can be (perhaps should be) changed. And, of course, it is necessary to change
_SERVER_LISTEN to the host name of the Raspberry Pi which, in my (fictitious) case, is:
modomo.twilightparadox.com as explained in 2.2 Public IP Address or Dynamic Host Name. Do not put the protocol prefix such as
https://, just the
domain name. As I explained above, the public IP address assigned to me by my ISP changes
so rarely that I could get away with the public IP address instead of a host name for testing purposes.
If the CIDR notation
192.168.99.0/24 is not familiar, just think of the trailing integer after the slash as the number of fixed most significant 1 bits in the subnet mask. Well, that's really clear. Perhaps working out the example will help. The subnet mask is 32 bits (or 4 bytes) of which the most significant 24 are 1s and the least significant 8 bits are 0. Hence the mask is 255.255.255.0. So the virtual network peers will have IP addresses in the
192.168.99.xxx block. The server will be at
192.168.99.1, the first client at
192.168.99.2, the second at
192.168.99.3 and so on. The script will handle this sequential allocation of IP addresses automatically.
The client configuration template,
client.conf.tpl, used by the script to create each user (or client) configuration file is quite short.
I changed the
Note that the first
192.168.99.1/32) is the address of the Wireguard server on the virtual network and the 32-bit mask means that the client/user will not be able to reach any other IP address on the
192.168.99.xx subnet. The second allowed IP address
192.168.1.0/24, which is the
192.168.1.xxx block of IP addresses corresponding to my home local network. The Raspberry Pi has a static IP address on that network:
192.168.1.22, the ISP supplied cable modem/router is at
192.168.1.1 and its integrated DHCP server allocates IP addresses in the
192.168.1.100-200 range where most of my IoT devices can be found. You will, of course, have to adjust the
AllowedIPs to refer to the correct IP addresses in your particular situation. It could be that your LAN is on subnet
192.168.1.xxx as suggest above, or
192.168.0.xxx, but some LANs use other blocks of private IPv4 addresses such as
In the server configuration template, it is assumed that the name of the network interface used by the
host of the WireGuard server is
eth0. In my case that
is not correct, the Raspberry Pi is connected by Wi-Fi to the LAN, so
it was necessary to edit the sever configuration template.
eth0 interface is replaced by
wlan0 in the
PostDown lines that define changes
to the server
iptables when activating or deactivating the
Again, this change needs to be done once only if at all.
If the (empty) configuration file,
wg0.conf, was not created when testing the installation of WireGuard in the section entitled Verifying that WireGuard is Properly Installed, now is the time it must be done.
This is done once only. The user management script will update this file each time it is used to add or delete a user. Consequently, the file should not be edited manually.
When first installing WireGuard and when testing the installation of the server, it is useful to manually start and stop the service. This is done with the
Note that the output will be more voluminous when the server configuration file is finally created as shown later.
Again when testing, it may be of value to check on the status of the VPN server. This can be done with the
systemd control utility and with the
The above is only an indication of the information that may be displayed. It will depend on the number of peers/clients that have been set up. Even more information will be displayed when a client or peer has created a tunnel (i.e. opened a VPN connection) including the number of bytes transmitted and received through the connection.
Once WireGuard is properly installed, the service should be started automatically. This is done with the usual
This is usually done only once. From then on, whenever the Raspberry Pi is booted,
systemd will start the VPN server. If for some reason the WireGuard server should not be started, use the disable command.
It will be possible to enable the service again later. If one thinks about it, a VPN server should really be functioning at all times.
Adrian Mihalko discusses setting up a mobile client on IOS using his script. Below, I show how to use the same script to set up clients in Android, Windows 10 and Linux. As will be seen, once the setup described above is finished, adding users with the script is rather simple.
When it is used to create a new user, the
user.sh script creates a configuration file for the instance of WireGuard running on the user's machine and it updates the server configuration file to accept a VPN connection (or tunnel) from the new client. Creating a user is very simple, start the WireGuard (even with an empty
wg0.conf file), and then run the
user.sh script with the
-a option followed by a unique name identifying the user/client to create.
█████████████████████████████████████████████████████████████ ████ ▄▄▄▄▄ █ ▄▄▄█ ▄ ██▀ █▄█▀▀▄▄██▄ █▀█ ▄ █▄ ▀██ ▄▄▄▄▄ ████ ████ █ █ █ ▀▄▀█ ██ █▄▀▀▀▄▀▄ ▄▀▄ █ █▄▀▄▄█▀ ▀▄▀█ █ █ ████ ████ █▄▄▄█ █▀▄▀█ ▀▀▀▄▄▀▄▀▄ ▀ ▄▄▄ ▄▄ ▄▄▀█▀▀█▀▀ ███ █▄▄▄█ ████ ████▄▄▄▄▄▄▄█▄▀ █▄▀▄█ ▀▄▀ ▀▄▀ █▄█ █ █ █ █▄█ ▀ █▄█▄█▄▄▄▄▄▄▄████ ████ ▄█▀ ▄▄▀▀▀ ▄ ▄█▀ ▄▀▄ ▀ ▄ ▄█▄ ▄▀██ ▀█▄ █ ▀█▄▀ ▄ ████ █████▀▀▄█ ▄ ▄ █▀▀▄▄▀ ▀██▄▄▄▀▄█▀█ ▄▄▀ █▀ ▀▄▀ ▀▄ ██▀▄█▀ ████ ████▄▄▄▀▀▀▄▀█▀▄██▄▀█ ▀█ ▀█▀█ ▀█▀█▀ ▀ █▀▄█▄█▄██ ▀██▀█ █▀▄▀████ ████▄▄▀▄▀ ▄█▀▄ █▄▄ ▀ ▀█ █ ▀ ▀█▄ ██▄ ▀ █▄▄▀█▄▀▄▄ ▄▀▀ █▄ ████ █████▄▄▄▄█▄ ▄▀▄▄▄▀▀▀▀█ █▀ ▄▄ ▄▄▀▄██ ██ █ ▀ █▀▀█ ▄▀█ █▀▀▀████ ████▀▀▀ ▄▄ ▄▄███▄█ ▀█▄▄ █ ▄█▀██ ▀▄▀ ▄█▄ ▄ ▀ ██▀█▄▀▄█▀▄████ █████▀▄▄█ ▄▄▀██▀█▄ ▄ ▀█ █ ██▀▀▄ ▀▀▀ █ ▄▀▄▄▀██▀▀▀▄▀█▀▀▀▄ ████ ████▀▀▀██ ▄█▄█ █▄▀█▄ ▀ █ ▀ ▄▀█▄ ▄▄▀▀▄▀▄▄▀████▀▄ ▀ ▀▄▀▄▄█████ ██████▄▄ ▄▄▄ █▄▀▄ ▄█▄▀▄▀▄▄▀ ▄▄▄ ▄▄ ▄▀█▀ ▄▄ ▄▄▄ ▄▄▄ ▀▄▀████ █████▀█▀ █▄█ ▄███▄ ▀ ▄▄█ ▀▄ █▄█ ▀█▄▀ ▀█▄ ▄ ▄ ██ █▄█ █ █ ████ █████▄▀ ▄▄ ▄█▀▄█▄▀▄▄█▄ ▄▀▄█▄▄▄▄▄█ ▀ ▀▀▄▀ ▄█▄█ ▀▄▄ ▄▀▀ ████ ████▄ ▄▀▄▄▄▀█▀▀██▄ ▄▀▄█▀ █▀▀█ █▄▀▀▄ ▄█▄ █▀▀▀▄ █▀▄ ▀▄▄▄████ ████▀██ ▄▄▄▄█▄▀██▀▀▀▀▀ ▄▀ █ ▀ ▄███▀▄▄████▀▀ ██▄ ▄ ▀▄▄▄▀██████ ████▄█▀ ▀▀▄█▀█▀▄▀██▄█▀ ▀█▄▀▀▀█ ███▀▄█ ▄█▄ ▄▄▀▀▄ █▀██▄█▄████ █████▀ █▄ ▄ ██▀██▄ ▄▄█▀▀▄▀▀▄█▀ ██▄▀ ▀▄▄█▄▄▀▀▀▀ ██ ▀▀█ ████ ████ ▄▄▀█▀▄ █▀▄ ▀█▀ ▀ █▀▀▀▄▀ █▄█ ▀▀█ ▄▄▀█▄ █ ▀██▄█▀ █ ▄████ ████▄▀▄▄▀█▄▀▄▄▄▀ ▄ ▄█▄▀█▀▄▄ ▄▄█▀█▄▄▄█▄▀▀ ▄█▀ ▀▀▄ ███ ▀ █████ ████▄ ▀▄▄▄▄ ▀ ██ █▄▀ ███ ▄█▀ ██▀█ ▄▀ ▀▀█ ▄███ █▄█▀ ▄▀█ ████ ███████▄██▄█▀ ▀▄▄ ▄ █▄ ██▀█ ▄▄▄ ▀█▀ ▀██▀▄▀▀▀██▄ ▄▄▄ ▀ ▀████ ████ ▄▄▄▄▄ █▀▀█ ▀ █▄██▀▀▄▄ █▄█ ▀██▀▀█▀▀▄ ██▄▄▄ █▄█ ▄ █████ ████ █ █ █▄ ██▄ ▀▀▀ █▄ ▄▄▄▄▄ ▄██ ▀▄███ ▀ ▀██▄ ▄▄ ▄▀▀▄████ ████ █▄▄▄█ █▀█▀ ▀▀▀▄█ ▄▀ ▀▄█▄▀▄ ▀█ ▄█▀█▄█▄ ▀▄▀██▀██▄█ ████ ████▄▄▄▄▄▄▄█▄▄▄▄▄▄▄▄▄█▄█▄█▄██▄█▄▄█▄█▄█▄█▄▄███▄▄█▄▄▄▄▄▄█▄█████ █████████████████████████████████████████████████████████████
The following message
will be printed just below the QR codes if the WireGuard service was not running on the Pi. In that case, rerun the two commands shown above. Don't worry about the QR code, it can be displayed later when needed to configure the WireGuard client on the Android or iOS device. The script executes very quickly but it nevertheless does quite a bit of work.
- It wrote a new WireGuard configuration
/etc/wireguard/wg0.conffile and saved a copy in
- It created a
~/wg_configwhere user/client directories will be stored as each user is added.
- It created the
nexus7client/user data files, including configuration files, and stored them in the
- It created work files in
.savedwhich contains the name, IP address and public key of every added client. This file is used to rebuild the server configuration file as new users are created.
.available_ipwhich contains a list of IP addresses on the WireGuard virtual network not yet assigned to the server or to clients.
Here is the content of the user directory just created.
There are two client configuration files,
client.all.conf and two QR code images that correspond to these configurations. One or both of these will be used to configure the Android or iOS client later on. Finally, as with the WireGuard server, the client has a private and
public encryption key.
Here is the content of one of the client configuration files and the server configuration file.
There are two sections to a WireGuard configuration file. The first,
[Interface] defines the IP address of the client or server on the virtual network. As already mentioned, the script will assign the first valid IP address on the virtual network,
192.168.99.1 to the Raspberry Pi hosting the server. So the script assigned the next valid address,
192.168.99.2, to the Nexus 7 client. The script also generated public and private keys for the client and server and includes the private key of each in its interface definition. The second part of the configuration file lists all the peers with which a tunnel can be established. To create the virtual connection, the client must know how to reach the server (the
Endpoint of its peer) and its public key. Similarly, the server must know its own address, on which UDP port it is listening, and the IP address and public key of any client (peer) that will be allowed to create a tunnel. Perhaps seeing the two configuration files side by side may make these links more obvious.
There is a second user configuration file.
It is identical to the first one except for the
AllowdIPs field. I use both configuration files as explained below.
To add an additional user, just repeat the steps. Remember to start the WireGuard server if it is not already running.
- The server is not running
- The server is running
A new directory with the new user configuration files and so on is created alongside the directories for the previously created users. The script updates its own list of IP addresses assigned to the clients and their public keys.
It also removes these assigned IP addresses from the list of available IPs.
/etc/wireguard/wg0.conf configuration file is created by the script.
The new client shows up as an additional
Peer in the server configuration file. That is all that needs to be done on the server for each additional client. All the "hard work" of editing templates and so on does not have to be repeated.
The first step in installing WireGuard in a Android device is to install the WireGuard Application from Google Play. Once that is done, launch the application.
Click on the blue button as told.
Click on Create from QR code.
The above images were displayed on a tablet with a larger screen. The same steps should be performed on a phone, but the appearance will probably be different as shown below.
Again, click on the
SCAN FROM QR CODE in the menu that is displayed on the bottom part of the screen.
It is now time to display the QR code image on the Raspberry Pi hosting the WireGuard server.
This time the two configuration files and the corresponding QR codes images will be displayed, but it will be necessary to scroll back to see them. Aim the device camera towards the QR code displayed on the desktop monitor. I started with the QR code for the
client.conf file (with AllowedIPs = 192.168.99.1/32, 192.168.1.0/24). Once the information was acquired, the following dialog appears.
I named the tunnel "Rpi3-split" and then pressed on the CREATE TUNNEL button. I repeated the steps to add the second tunnel, named "RPi-all", from the second QR code.
Again, the layout will be different on the smaller screen of a phone but functionally it is the same.
In the larger screen, the list of tunnels is always displayed in the left panel of the screen and the "public" information about each tunnel is is displayed on the right panel as the tunnel is selected. In the smaller screen either the list of tunnels is displayed or the public information for a single tunnel is displayed when it is selected. In the later case, there is a backward pointing arrow to go back to the list of tunnels.
The release of an official WireGuard client for Windows was a welcomed development for many. It makes it just as easy to add WireGuard tunnels and activate them as the Android app shown above. First download the correct 32 or 64 bit version from the WireGuard Installation page. These are Windows Installer Packages, so a mouse click on the downloaded file is all that is required to start the installation. And that's basically it, once the installation is completed, the WireGuard icon is visible in the Windows Tray.
The first time the client is started by clicking on the icon, an empty list of tunnels is visible and there is an option to
Import tunnel(s) from file.
That's what I did and I was rewarded with the following.
Of course that raises the questions of where does the imported file come from? That's quite simple. I took the two client configuration files generated by the
user.sh script, renamed them and then created a zip archive containing those files. There are doubtless many ways of doing this, here is how I went about it.
I downloaded and installed the latest version of PuTTY on a Windows 10 machine: Download PuTTY: latest release. Then I started its SFTP client
PSFTP from the menu and used it to download the two client configuration files in
~/wg_config/users/winnner where a new user called "winner" were stored on the
oldpi system. The user was created with the
user.sh script as explained twice over above.
After that I renamed the configuration files to something more meaningful:
client.conf --> oldpi-split.conf client.all.conf --> oldpi-all.conf
I then simply created a Zip archive named
oldpi.zip containing the two renamed configuration files. This is done in
File Explorer by selecting the files and then clicking on the Zip icon in the
Share ribbon and adjusting the name of the archive. This is the file I then selected to import in the WireGuard Window client.
To the best of my knowledge there is no such thing as a Wireguard client for Linux because the VPN is actually a peer-to-peer protocol. What we will be doing is installing WireGuard on a Linux host just as done on the Raspberry Pi above. The only significant difference will be in the configuration.
The Linux machine on which I installed WireGuard is a portable computer with Linux Mint 19.2
Xfce which I want to use to connect with my home network from remote locations. My first action was to update the system and then check to make sure that WireGuard was not already installed.
This is not the most up-to-date version according to the Installation page but I nevertheless installed the package in the repository.
The same tests done on the Raspberry Pi can be used to check that the modules and tools have been installed.
Configuring this instance of WireGuard as a "client" could hardly be simpler. I used FileZila to copy the
client.all.conf configuration files from the Raspberry Pi
/home/pi/wg_config/users/tosh directory. These files were created by the
users.sh script as explained above. After that I renamed the configuration files to something more meaningful:
client.conf --> oldpi-split.conf client.all.conf --> oldpi-all.conf
I then moved the configuration files to the
/etc/wireguard directory and erased the empty
wg0.conf file that was created to test the installation but which will not be used. I also made sure that
root is the owner of the configuration files which is an added security measure.
That's all there is to setting up a Linux client which is basically the same as what was done to configure the Windows client. There are three main differences with the server configuration.
- A WireGuard server typically has one configuration file, but each client may have many configuration files, one for each WireGuard tunnels that can be opened. Most often my clients can open one of two tunnels with each available VPN server. While running some preliminary tests I have had as many as 8 configuration files on the portable system, while each server (there were 4 servers at one point) had one configuration file. The latter had to contain the authorization information for all the clients (called "peers" in the file) allowed to open a tunnel.
- A client configuration file does not have iptable routing commands. This is because it does not pass on IP traffic to other devices on the local network to which it is connected. That's also why it was not necessary to enable IP forwarding on the client.
- WireGuard is not automatically started at boot time on a client. Only under very peculiar circumstances would it make sense to always connect a client to a VPN server. Having said this, some seem to want to do this with VPN service providers. These may be more reliable than a self hosted VPN service on a Raspberry Pi. Do remember that if a tunnel with an allowed IP setting of
0.0.0.0/0is automatically started on a client then it would in effect be disconnected from the net should the VPN server be down. This can be a bit disconcerting.
user.sh script can also be used to remove a single user
or all users at once.
Of course, the server configuration file will also be updated.
Imagine the following scenario. I am sitting in a coffee shop, and I want to see the video feed from an IP camera at home. On the local network, I would start VLC and view the stream at the following address:
rtsp://192.168.1.95/11. On my tablet, I can do exactly the same thing as long as I start the WireGuard application and open one of the tunnels to the VPN server at home and if the WireGuard VPN server is running on the local network at home.
I just slide the wanted tunnel button to the right as shown above. On my Android phone the connection details are displayed by clicking on the tunnel name, but opening a tunnel would be done just the same, by sliding to the right the control beside the desired tunnel. As soon as that is done, I have access to all resources on my home network on
192.168.1.xxx just as if my Android device were connected directly to the LAN. I can therefore watch the
rtsp://192.168.1.95/11 video stream as if I were home. It is so simple and yet secure. Anyone eavesdropping on the Wi-Fi network in the shop or anywhere along the route between my tablet and my home router would see IP packets with encrypted content. Instead of seeing the address
192.168.1.95:554 from which it could be surmised that there is an IP camera on my home network (554 is the typical RTSP port), the visible address will be
220.127.116.11:53133 which is the public IP address of the router and the obscure port used by the WireGuard interface which encodes everything else end-to-end, including the final destination address.
Note that the Android client gives very little feedback when opening a tunnel. A little key icon signifying the VPN is active will be shown at the top of the device screen. But that icon is present even if the settings are wrong or if the WireGuard server at home is not online. The only "symptom" that something is wrong will be that all devices on the
192.168.1.xxx subnet are unreachable and the WireGuard app will probably show that the number of received bytes is zero.
What if I decide to consult the latest stock market indices? I would start a web browser and go to the say Yahoo! Finance in Canada:
https://ca.finance.yahoo.com/. The destination IP,
18.104.22.168, is not on the
192.168.1.xxx subnet so routing of the packets would not go through the WireGuard tunnel. Instead, packets will be routed directly as if WireGuard was not even running. Anyone eavesdropping on the Wi-Fi network may be able to follow the data sent and received by the Android device. Actually, that's exaggerated: addresses could be traced, but the actual data is encoded and should be almost impossible to crack.
If I then want to check my bank balance, I can either start a Web browser and establish a secure HTTPS connection with the bank's Web server or use the Google Play Store app provided by the bank. Either way, I am counting on the built-in encryption of the data exchanged to keep my password and the details of my finances private. However, being paranoid, before checking the balance, I usually start the other tunnel that I named
test-all where the
Allowed IPs field is
0.0.0.0/0. That means all traffic in and out of my device is sent to my home network and from there it is routed to its final destination. So my outgoing financial data is double encrypted on the first leg of its journey out of the coffee shop and incoming data is also double encrypted on the last leg from my home network. Maybe I should wear a tin foil hat to protect myself from the nefarious 5G network at the same time because for most of the way, the data is transiting all sorts of bridges, routers, backbones and so on with no more and no less encryption than when I consult my bank balance from my desktop computer at home. Still I find it reassuring to use the "universal" WireGuard tunnel at all times when using a public hotspot. No harm is done, and there is no perceptible slow down even with the extra hop involved.
Of course, if you use a public hotspot in search of anonymity, don't use the
Allowed IPs=0.0.0.0/0 configuration because you are in effect using your own ISP account. On the other hand, do not assume that a public hotspot provides true anonymity. The coffee shop server knows which IP was assigned to your computer and the MAC address of the network card of your computer and may very well save that type of information.
Using the Windows client is just as simple. Start WireGuard by clicking its icon in the system tray, and then select the desired tunnel in the list on the left.
Click on the Activate button and if all goes well the VPN will be in place.
As one would assume, the Deactivate button closes an open tunnel.
Since there is no graphic WireGuard client for Linux, the command line the
wg-quick tool to start and stop tunnels must be used to connect to the local area network from a remote location with the Linux Mint portable. Sometimes I am running many VPN servers for test purposes, so I often list all the installed configuration files before just to recall their exact name. Then starting a tunnel is quite easy as long as I remember the command and also remember not to include the
.conf extension in the tunnel name.
Closing the tunnel is just as easy, but you must use the correct tunnel name which, again, I often forget. Thankfully,
wg shows the currently used tunnel name.
Once you have thoroughly tested everything, I suggest it is time to look at all ports that were being forwarded at the LAN firewall. I was able to remove all holes punched through it for the home automation system, for IP cameras and so on and replace them with a single UDP port forwarded to the WireGuard service. Now there's a single small black hole in the firewall. Try it and you too may get a warm fuzzy feeling of security. Hopefully, I will not regret this in the future.
Perhaps a cautious approach would be warranted in some circumstances, meaning that it may be preferable to wait until WireGuard makes it to the stable release of the operating system. It should not take too long before WireGuard is incorporated into the Raspberry Pi OS image (as is currently the case with Armbian and Ubuntu) or easily installed with a simple sudo apt install. However, experience shows that even stable releases of a new version of the operating system can break things, so if I had to install WireGuard on a Raspberry Pi, no matter which model, I would just go ahead and follow Daniel T. Wagner's instructions to install the package from the Raspbian
testing repository, but I would make sure to install Raspberry Pi OS to a new SD card, keeping my original SD card as a safe back up.
Some may wonder about the throughput of the VPN. I was surprised that the VPN performed adequately even when routing all Internet traffic through it. This was true when the VPN service was running on a single core Raspberry Pi 1 (similar to a Pi Zero). It is true that my bandwidth demands are usually relatively light when I am in a coffee shop. Nevertheless, YouTube videos could be streamed simultaneously on a tablet and portable without noticeable degradation. Of course these were not in high-definition, but then I do not anticipate a pressing need to view 4K videos in coffee shops in the forseeable future.
Including WireGuard in the Linux kernel will hasten its adoption by an ever-growing number of users. In my opinion, that is a good thing as I have found the VPN to be very reliable and its use surprisingly seamless. That being said, I encountered a problem using WireGuard. Many public access points block forwarding of UDP datagrams to most ports, and WireGuard only uses this protocol. Three coffee chains with outlets across North America and beyond do not yet have such a restrictive policy, but in many institutional setting this is the case. It appears that a big well known international fast food chain base in the USA also blocks UDP traffice. I wanted to take a closer look at this issue before physical access to restaurants was suspended due to the risks associated with the coronavirus. This investigation will have to wait until the situation returns to normal.