[feature] Adding Wireguard and VXLAN support #187

nemesifier · 2021-04-03T21:52:00Z

What's missing:

Fix test coverage
Wireguard page docs
Add Wireguard settings (interface and peers settings, + examples) to OpenWRT backend docs
Add VXLAN settings (interface settings + example) to OpenWRT backend docs

Postponed: #188.

coveralls · 2021-04-03T21:53:38Z

Coverage increased (+0.007%) to 99.94% when pulling 6365223 on wireguard-vxlan into a0cda13 on master.

pandafy · 2021-04-29T15:30:10Z

netjsonconfig/backends/openwrt/openwrt.py

+            config['interfaces'][0]['addresses'] = [
+                {
+                    'proto': 'static',
+                    'family': 'ipv4',


We can't know whether the IP address will belong to IPv4 or IPv6 family since we are dealing with variables here.

pandafy · 2021-04-29T15:31:06Z

netjsonconfig/backends/openwrt/schema.py

@@ -307,7 +307,6 @@
                                                    "type": "string",
                                                    "title": "ipv4 address",
                                                    "minLength": 7,
-                                                    "format": "ipv4",


This was preventing to us to use variable name in templates

nemesifier

@pandafy let's make sure Wireguard is mentioned in the README (we have OpenVPN so it makes sense to mention Wireguard as well).

nemesifier

Sorry I forgot to mention to mention WireGuard it here too: https://github.com/openwisp/netjsonconfig/blob/master/docs/source/index.rst

nemesifier · 2021-05-26T02:44:08Z

docs/source/backends/vpn/wireguard.rst

@@ -0,0 +1,193 @@
+=================


is this file listed in the toctree? I tried generating the docs and don't see it in the menu.

No this is not in the toctree. You will see this after clicking on the VPN backends link.

@nemesisdesign can this be resolved?

nemesifier · 2021-05-26T02:44:14Z

docs/source/backends/vpn/vxlan_over_wireguard.rst

@@ -0,0 +1,78 @@
+============================


is this file listed in the toctree? I tried generating the docs and don't see it in the menu.

docs/source/backends/vpn/openvpn.rst

docs/source/backends/openwrt.rst

nemesifier · 2021-05-27T01:39:32Z

docs/source/backends/vxlan_over_wireguard.rst

+.. include:: ../_github.rst
+
+The ``VXLAN over WireGuard`` backend extends :doc:`Wireguard backend </backends/wireguard>`
+to add configurations required for VXLAN.


I think something like configurations required for configuring VXLAN tunnels encapsulated in WireGuard tunnels. may be more specific and clear.

nemesifier · 2021-05-27T01:41:53Z

docs/source/backends/openwrt.rst

+            option route_allowed_ips '1'
+
+VXLAN over WireGuard
+--------------------


I think there's a misunderstanding here.

VXLAN can work independently from wireguard, so we should document it independently.

VXLAN is a layer 2 tunnel which can be encapsulated in any L3 technology, so I don't think we need to specify VXLAN over wireguard.

Maybe, we can leave one last example showing how to encapsulate a vxlan tunnel in a wireguard tunnel.

mips171 · 2021-05-31T03:29:53Z

docs/source/backends/openwrt.rst

+|                       |         |           |                                                                 |
+|                       |         |           | 2 to 15 alphanumeric characters, dashes and underscores         |
+-----------------------+---------+-----------+-----------------------------------------------------------------+
+| ``route_allowed_ips`` | boolean | ``False`` | automatically create a route for each Allowed IPs for this peer |


It's fine but automatically create a route for each of the Allowed IPs for this peer flows more smoothly.

mips171

Docs look good

nemesifier

@pandafy can you address this suggestion please?
#187 (review)

The rest looks good and I think we should merge!

nemesifier

@pandafy it's ready to merge but I think we can squash/group some commits of yours to keep history tidy, please proceed when you can.

Related to #185

Related to #186

…RT backend

- Added examples for WireGuard, VXLAN and VXLAN over WireGuard - Updated OpenWrt documentation to describle usage of auto_client methods

nemesifier added the enhancement label Apr 3, 2021

nemesifier self-assigned this Apr 3, 2021

nemesifier added this to In progress in OpenWISP Priorities for next releases via automation Apr 3, 2021

nemesifier assigned pandafy Apr 5, 2021

pandafy force-pushed the wireguard-vxlan branch from 5c28cb4 to 8f50313 Compare April 16, 2021 15:28

pandafy reviewed Apr 29, 2021

View reviewed changes

nemesifier mentioned this pull request May 10, 2021

[feature] Add support for defining a static IP address on the VXLAN interface #188

Open

pandafy force-pushed the wireguard-vxlan branch from 5b1ae31 to d3ba072 Compare May 11, 2021 11:25

nemesifier commented May 22, 2021

View reviewed changes

nemesifier commented May 26, 2021

View reviewed changes

pandafy force-pushed the wireguard-vxlan branch 2 times, most recently from 5aa0b36 to 51338a8 Compare May 26, 2021 20:37

nemesifier commented May 27, 2021

View reviewed changes

mips171 reviewed May 31, 2021

View reviewed changes

OpenWISP Priorities for next releases automation moved this from In progress to Reviewer approved May 31, 2021

mips171 previously approved these changes May 31, 2021

View reviewed changes

pandafy dismissed mips171’s stale review via 1b0d928 June 28, 2021 19:32

OpenWISP Priorities for next releases automation moved this from Reviewer approved to In progress Jun 28, 2021

pandafy force-pushed the wireguard-vxlan branch from 1b0d928 to 24a87f2 Compare June 28, 2021 19:54

nemesifier commented Aug 16, 2021

View reviewed changes

nemesifier commented Aug 18, 2021

View reviewed changes

nemesifier added 6 commits August 19, 2021 19:07

[feature] Add Wireguard support #185

dd3238e

Related to #185

[feature] Added support for VXLAN interfaces #186

d62ee4d

Related to #186

[chores] Moved shared VPN backend logic to BaseVpnBackend

1b0f260

[feature] Added wireguard interfaces and peers to OpenWRT

d00dc95

[chores] Wireguard: public_key and allowed_ips shall not be empty

8c40e97

[fix] Updated modem-manager interface code

be1f097

pandafy added 3 commits August 19, 2021 20:05

[feature] Added autoclient classmethods to Wireguard, VXLAN and OpenW…

e36d3fc

…RT backend

[docs] Added documentation for WireGuard and VXLAN VPN backend

8af254f

- Added examples for WireGuard, VXLAN and VXLAN over WireGuard - Updated OpenWrt documentation to describle usage of auto_client methods

[ci] Updated package install command

6365223

pandafy force-pushed the wireguard-vxlan branch from f7e9903 to 6365223 Compare August 19, 2021 14:39

nemesifier merged commit b09d8a7 into master Aug 20, 2021

OpenWISP Priorities for next releases automation moved this from In progress to Done Aug 20, 2021

nemesifier deleted the wireguard-vxlan branch February 18, 2022 19:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature] Adding Wireguard and VXLAN support #187

[feature] Adding Wireguard and VXLAN support #187

nemesifier commented Apr 3, 2021 •

edited by pandafy

Loading

coveralls commented Apr 3, 2021 •

edited

Loading

pandafy Apr 29, 2021

pandafy Apr 29, 2021

nemesifier left a comment

nemesifier left a comment

nemesifier May 26, 2021

pandafy May 26, 2021

pandafy May 26, 2021

nemesifier May 26, 2021

nemesifier May 27, 2021

nemesifier May 27, 2021

mips171 May 31, 2021

mips171 left a comment

nemesifier left a comment

nemesifier left a comment

[feature] Adding Wireguard and VXLAN support #187

[feature] Adding Wireguard and VXLAN support #187

Conversation

nemesifier commented Apr 3, 2021 • edited by pandafy Loading

coveralls commented Apr 3, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mips171 left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier left a comment

Choose a reason for hiding this comment

nemesifier commented Apr 3, 2021 •

edited by pandafy

Loading

coveralls commented Apr 3, 2021 •

edited

Loading