[feature] Added wireguard interfaces and peers to OpenWRT

Author: nemesifier

netjsonconfig/backends/openwrt/converters/__init__.py

@@ -8,6 +8,7 @@
 from .routes import Routes
 from .rules import Rules
 from .switch import Switch
+from .wireguard_peers import WireguardPeers
 from .wireless import Wireless
 
 __all__ = [
@@ -21,5 +22,6 @@
     'Routes',
     'Rules',
     'Switch',
+    'WireguardPeers',
     'Wireless',
 ]

netjsonconfig/backends/openwrt/converters/base.py

@@ -6,7 +6,7 @@ class OpenWrtConverter(BaseConverter):
 
     def should_skip_block(self, block):
         _type = block.get('.type')
-        return not block or _type not in self._uci_types
+        return not block or (self._uci_types and _type not in self._uci_types)
 
     def _get_uci_name(self, name):
         return name.replace('.', '_').replace('-', '_')

netjsonconfig/backends/openwrt/converters/interfaces.py

@@ -4,7 +4,6 @@
 
 from ..schema import schema
 from .base import OpenWrtConverter
-from ..schema import schema
 
 
 class Interfaces(OpenWrtConverter):
@@ -46,8 +45,9 @@ def __intermediate_addresses(self, interface):
         converts NetJSON address to
         UCI intermediate data structure
         """
-        if interface.get('proto') == 'wireguard':
-            return self.__intermediate_wg_addresses(interface)
+        # wireguard interfaces need a different format
+        if interface.get('type') == 'wireguard':
+            return self.__intermediate_wireguard_addresses(interface)
         address_list = self.get_copy(interface, 'addresses')
         # do not ignore interfaces if they do not contain any address
         if not address_list:
@@ -86,9 +86,15 @@ def __intermediate_addresses(self, interface):
             result += dhcp
         return result
 
-    def __intermediate_wg_addresses(self, interface):
-        address_list = interface.pop('wg_addresses')
-        static = {'addresses': address_list, 'proto': interface['proto']}
+    def __intermediate_wireguard_addresses(self, interface):
+        addresses = interface.pop('addresses')
+        address_list = []
+        for address_dict in addresses:
+            address = address_dict['address']
+            if 'mask' in address_dict:
+                address = f'{address}/{address_dict["mask"]}'
+            address_list.append(address)
+        static = {'addresses': address_list, 'proto': 'wireguard'}
         return [static]
 
     def __intermediate_interface(self, interface, uci_name):
@@ -97,9 +103,7 @@ def __intermediate_interface(self, interface, uci_name):
         UCI intermediate data structure
         """
         interface.update({'.type': 'interface', '.name': uci_name})
-        name = interface.pop('name')
-        if interface.get('proto') != 'wireguard':
-            interface['ifname'] = name
+        interface['ifname'] = interface.pop('name')
         if 'network' in interface:
             del interface['network']
         if 'mac' in interface:
@@ -130,6 +134,12 @@ def _intermediate_modem_manager(self, interface):
         interface['proto'] = 'modemmanager'
         interface['pincode'] = interface.pop('pin', None)
 
+    def _intermediate_wireguard(self, interface):
+        interface['proto'] = 'wireguard'
+        interface['listen_port'] = interface.pop('port', None)
+        del interface['ifname']
+        return interface
+
     def _intermediate_vxlan(self, interface):
         interface['proto'] = 'vxlan'
         interface['peeraddr'] = interface.pop('vtep')
@@ -320,6 +330,25 @@ def _netjson_modem_manager(self, interface):
 
     _netjson_modemmanager = _netjson_modem_manager
 
+    _wireguard_schema = schema['definitions']['wireguard_interface']['allOf'][0]
+
+    def _netjson_wireguard(self, interface):
+        interface['type'] = interface.pop('proto', None)
+        interface['port'] = interface.pop('listen_port', None)
+        addresses = []
+        for address in interface['addresses']:
+            cidr = ip_interface(address)
+            addresses.append(
+                {
+                    'address': str(cidr.ip),
+                    'mask': cidr.network.prefixlen,
+                    'proto': 'static',
+                    'family': f'ipv{cidr.ip.version}',
+                }
+            )
+        interface['addresses'] = addresses
+        return self.type_cast(interface, schema=self._wireguard_schema)
+
     _vxlan_schema = schema['definitions']['vxlan_interface']['allOf'][0]
 
     def _netjson_vxlan(self, interface):

netjsonconfig/backends/openwrt/converters/wireguard_peers.py

@@ -0,0 +1,34 @@
+from ..schema import schema
+from .base import OpenWrtConverter
+
+
+class WireguardPeers(OpenWrtConverter):
+    netjson_key = 'wireguard_peers'
+    intermediate_key = 'network'
+    _schema = schema['properties']['wireguard_peers']['items']
+    # unfortunately due to the design of the
+    # wireguard OpenWRT package, this is unpredictable
+    _uci_types = None
+
+    def to_intermediate_loop(self, block, result, index=None):
+        result.setdefault('network', [])
+        result['network'].append(self.__intermediate_peer(block))
+        return result
+
+    def __intermediate_peer(self, peer):
+        interface = peer.pop("interface")
+        peer.update({'.type': f'wireguard_{interface}', '.name': f'wgpeer_{interface}'})
+        if not peer.get('endpoint_host') and 'endpoint_port' in peer:
+            del peer['endpoint_port']
+        return self.sorted_dict(peer)
+
+    def to_netjson_loop(self, block, result, index):
+        result.setdefault('wireguard_peers', [])
+        result['wireguard_peers'].append(self.__netjson_peer(block))
+        return result
+
+    def __netjson_peer(self, peer):
+        del peer['.name']
+        interface = peer.pop('.type').replace('wireguard_', '')
+        peer['interface'] = interface
+        return self.type_cast(peer)

netjsonconfig/backends/openwrt/openwrt.py

@@ -22,6 +22,7 @@ class OpenWrt(BaseBackend):
         converters.Radios,
         converters.Wireless,
         converters.OpenVpn,
+        converters.WireguardPeers,
         converters.Default,
     ]
     parser = OpenWrtParser