SMEServer Wireguard

From Realm Business Systems Ltd
Jump to: navigation, search

Template:Languages {{#vardefine:contribname| {{#titleparts: smeserver wireguard |1}} }} {{#vardefine:smecontribname| smeserver-{{#titleparts: smeserver wireguard |1}} }} {{#vardefine:lang| {{#titleparts: smeserver wireguard | | -1}} |en }} Template:Infobox contribs

Maintainer

Jean-Philippe Pialasse

Version

{{#smeversion: {{#var:smecontribname}} }}

Description

As always we worked to make it Simple and Stupid. Wireguard is the easiest VPN server to set, but we managed to make it even easier for you !

according to WireGuard website:

WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and simplest VPN solution in the industry.

Installation

<tabs container=""><tab name="For SME 10">

yum --enablerepo=smecontribs install {{#var:smecontribname}}

then log to your server-manager to start adding clients. </tab></tabs>

Configuration

using server-manager

On the main panel you can see at a glance, server configuration, connected clients, and configured clients.

File:Wireguard-config.png
configure the server

You can adjust the server configuration: disable the service, change the server main Ip and mask. Default will generate a class B network for more than 1000 device connected, looking that all your users might want a dedicated client for every devices (phone, pad, laptop...). 172.* class B tends to be less commonly used than 192.168.* class C network or 10.+ class A network, so this also should limit collision for your clients behind a LAN when launching their VPN session.

The private and public key are generated upon installation, but if you have specific needs, go ahead and play with them.

To add a new client simply press the button, and select a user that will be associated to this client, and give some information about this client. IF you want to create a client for the phone of the admin, simply type "phone", then press create button and private"/public key will be generated and first available ip will be associated to the client.

File:Wireguard-qrcode.png
get client configuration and qrcode

You can easily configure your client using a qrcode or a generated configuration.

File:Wireguard-edit-client.png
client modification


If you want to alter the client configuration you can do so on this screen, you can even remove the private key if you do not want it on the server, or set your own public key without revealing the private key, it is only needed to generate the qrcode, not to allow you to connect.

advanced manual configuration

you can list the available configuration with the following command :

config show wg-quick@wg0

Some of the properties are not shown, but are defaulted in a template or a script. Here a more comprehensive list with default and expected values :

property default values
UDPPort 51820 string should keep this one as default, but free to do as you want
mask 22 network mask bit the default allow 1024 hosts
ip 172.X.0.1 IP v4 one class B IP is generated on installation, feel free to set as you want
private string private key, generated
public string public key, generated
access private private, public
status enabled enabled,disabled


You can also check the configured clients:

db wireguard show 172.X.0.2


property default values
allowedips list of ip/mask default is empty for all 0.0.0.0/0
info string name or information about the client
ip 172.X.0.Y IP v4 should be part of wg0 network
private string private key, generated
public string public key, generated
status enabled enabled,disabled


Sources of information


Uninstall

yum remove {{#var:smecontribname}}  {{#var:contribname}} wireguard-tools kmod-wireguard

Bugs

Please raise bugs under the SME-Contribs section in Template:BugzillaFileBug and select the {{#var:smecontribname}} component or use Template:BugzillaFileBug

Below is an overview of the current issues for this contrib:{{#bugzilla:columns=id,product,version,status,summary|sort=id|order=desc|component={{#var:smecontribname}} |noresultsmessage=No open bugs found.}}

Changelog

Only released version in smecontrib are listed here.

{{#smechangelog: {{#var:smecontribname}} }}