Merge pull request #747 from c-po/vxlan-tunnel-parameters

vyos.ifconfig: cleanup and tunnel refactoring

1 files changed, 86 insertions, 189 deletions

diff --git a/python/vyos/ifconfig/tunnel.py b/python/vyos/ifconfig/tunnel.py
index 4320bf8bc..bb940b0cf 100644
--- a/python/vyos/ifconfig/tunnel.py
+++ b/python/vyos/ifconfig/tunnel.py
@@ -1,4 +1,4 @@
-# Copyright 2019-2020 VyOS maintainers and contributors <maintainers@vyos.io>
+# Copyright 2019-2021 VyOS maintainers and contributors <maintainers@vyos.io>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -16,13 +16,12 @@
 # https://developers.redhat.com/blog/2019/05/17/an-introduction-to-linux-virtual-interfaces-tunnels/
 # https://community.hetzner.com/tutorials/linux-setup-gre-tunnel
 
-from copy import deepcopy
-
 from netaddr import EUI
 from netaddr import mac_unix_expanded
 from random import getrandbits
 
 from vyos.ifconfig.interface import Interface
+from vyos.util import dict_search
 from vyos.validate import assert_list
 
 def enable_to_on(value):
@@ -32,11 +31,10 @@ def enable_to_on(value):
         return 'off'
     raise ValueError(f'expect enable or disable but got "{value}"')
 
-
 @Interface.register
-class _Tunnel(Interface):
+class TunnelIf(Interface):
     """
-    _Tunnel: private base class for tunnels
+    Tunnel: private base class for tunnels
     https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/tunnel.c
     https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/ip6tunnel.c
     """
@@ -48,16 +46,30 @@ class _Tunnel(Interface):
         },
     }
 
-    default = {
-        'local' : '',
-        'remote': '',
-        'dev' : '',
-        'ttl' : '',
-        'tos' : '',
-        'key' : '',
-        'raw' : '',
+    # This table represents a mapping from VyOS internal config dict to
+    # arguments used by iproute2. For more information please refer to:
+    # - https://man7.org/linux/man-pages/man8/ip-link.8.html
+    # - https://man7.org/linux/man-pages/man8/ip-tunnel.8.html
+    mapping = {
+        'source_address'                  : 'local',
+        'source_interface'                : 'dev',
+        'remote'                          : 'remote',
+        'parameters.ip.key'               : 'key',
+        'parameters.ip.tos'               : 'tos',
+        'parameters.ip.ttl'               : 'ttl',
+    }
+    mapping_ipv4 = {
+        'parameters.ip.key'               : 'key',
+        'parameters.ip.no_pmtu_discovery' : 'nopmtudisc',
+        'parameters.ip.tos'               : 'tos',
+        'parameters.ip.ttl'               : 'ttl',
+    }
+    mapping_ipv6 = {
+        'parameters.ipv6.encaplimit'      : 'encaplimit',
+        'parameters.ipv6.flowlabel'       : 'flowlabel',
+        'parameters.ipv6.hoplimit'        : 'hoplimit',
+        'parameters.ipv6.tclass'          : 'tclass',
     }
-    options = Interface.options + list(default.keys())
 
     # TODO: This is surely used for more than tunnels
     # TODO: could be refactored elsewhere
@@ -76,28 +88,67 @@ class _Tunnel(Interface):
             },
         }
     }
-    _create_cmd = 'ip tunnel add {ifname} mode {type}'
+
+    def __init__(self, ifname, **kargs):
+        self.iftype = kargs['encapsulation']
+        super().__init__(ifname, **kargs)
+
+        # The gretap interface has the possibility to act as L2 bridge
+        if self.iftype == 'gretap':
+            # no multicast, ttl or tos for gretap
+            self.definition = {
+                **TunnelIf.definition,
+                **{
+                    'bridgeable': True,
+                },
+            }
+
 
     def _create(self):
-        # add " option-name option-name-value ..." for all options set
-        options = ' '.join(['{} {}'.format(k, self.config[k])
-                            for k,v in self.config.items() if v and k not in
-                                                    ['ifname', 'type', 'raw']])
-        if 'raw' in self.config:
-            options += ' ' + ' '.join(self.config['raw'])
-        self._cmd('{} {}'.format(self._create_cmd.format(**self.config), options))
-        self.set_admin_state('down')
+        if self.config['encapsulation'] in ['ipip6', 'ip6ip6', 'ip6gre']:
+            mapping = { **self.mapping, **self.mapping_ipv6 }
+        else:
+            mapping = { **self.mapping, **self.mapping_ipv4 }
+
+        cmd = 'ip tunnel add {ifname} mode {encapsulation}'
+        if self.iftype == 'gretap':
+            cmd = 'ip link add name {ifname} type {encapsulation}'
+        for vyos_key, iproute2_key in mapping.items():
+            # dict_search will return an empty dict "{}" for valueless nodes like
+            # "parameters.nolearning" - thus we need to test the nodes existence
+            # by using isinstance()
+            tmp = dict_search(vyos_key, self.config)
+            if isinstance(tmp, dict):
+                cmd += f' {iproute2_key}'
+            elif tmp != None:
+                cmd += f' {iproute2_key} {tmp}'
+
+        self._cmd(cmd.format(**self.config))
 
-    def change_options(self):
-        change = 'ip tunnel change {ifname} mode {type}'
+        self.set_admin_state('down')
 
-        # add " option-name option-name-value ..." for all options set
-        options = ' '.join(['{} {}'.format(k, self.config[k])
-                            for k,v in self.config.items() if v and k not in
-                                                    ['ifname', 'type', 'raw']])
-        if 'raw' in self.config:
-            options += ' ' + ' '.join(self.config['raw'])
-        self._cmd('{} {}'.format(change.format(**self.config), options))
+    def _change_options(self):
+        # gretap interfaces do not support changing any parameter
+        if self.iftype == 'gretap':
+            return
+
+        if self.config['encapsulation'] in ['ipip6', 'ip6ip6', 'ip6gre']:
+            mapping = { **self.mapping, **self.mapping_ipv6 }
+        else:
+            mapping = { **self.mapping, **self.mapping_ipv4 }
+
+        cmd = 'ip tunnel change {ifname} mode {encapsulation}'
+        for vyos_key, iproute2_key in mapping.items():
+            # dict_search will return an empty dict "{}" for valueless nodes like
+            # "parameters.nolearning" - thus we need to test the nodes existence
+            # by using isinstance()
+            tmp = dict_search(vyos_key, self.config)
+            if isinstance(tmp, dict):
+                cmd += f' {iproute2_key}'
+            elif tmp != None:
+                cmd += f' {iproute2_key} {tmp}'
+
+        self._cmd(cmd.format(**self.config))
 
     def get_mac(self):
         """
@@ -128,6 +179,8 @@ class _Tunnel(Interface):
         get_config_dict(). It's main intention is to consolidate the scattered
         interface setup code and provide a single point of entry when workin
         on any interface. """
+        # Adjust iproute2 tunnel parameters if necessary
+        self._change_options()
 
         # call base class first
         super().update(config)
@@ -141,159 +194,3 @@ class _Tunnel(Interface):
         # reconfiguration.
         state = 'down' if 'disable' in config else 'up'
         self.set_admin_state(state)
-
-class GREIf(_Tunnel):
-    """
-    GRE: Generic Routing Encapsulation
-
-    For more information please refer to:
-    RFC1701, RFC1702, RFC2784
-    https://tools.ietf.org/html/rfc2784
-    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/link_gre.c
-    """
-
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'gre',
-            'raw' : ['pmtudisc'], # parameters that we can pass raw to ip command
-        },
-    }
-
-# GreTap also called GRE Bridge
-class GRETapIf(_Tunnel):
-    """
-    GRETapIF: GreIF using TAP instead of TUN
-
-    https://en.wikipedia.org/wiki/TUN/TAP
-    """
-    # no multicast, ttl or tos for gretap
-    definition = {
-        **_Tunnel.definition,
-        **{
-            'bridgeable': True,
-        },
-    }
-    default = {
-        'type': 'gretap',
-        'local': '',
-        'remote': '',
-        'dev': '',
-        'raw' : ['pmtudisc'], # parameters that we can pass raw to ip command
-    }
-
-    _create_cmd = 'ip link add name {ifname} type {type}'
-
-    def change_options(self):
-        pass
-
-class IP6GREIf(_Tunnel):
-    """
-    IP6Gre: IPv6 Support for Generic Routing Encapsulation (GRE)
-
-    For more information please refer to:
-    https://tools.ietf.org/html/rfc7676
-    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/link_gre6.c
-    """
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'ip6gre',
-            'encaplimit': '',
-            'hoplimit': '',
-            'tclass': '',
-            'flowlabel': '',
-        },
-    }
-
-class IPIPIf(_Tunnel):
-    """
-    IPIP: IP Encapsulation within IP
-
-    For more information please refer to:
-    https://tools.ietf.org/html/rfc2003
-    """
-    # IPIP does not allow to pass multicast, unlike GRE
-    # but the interface itself can be set with multicast
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'ipip',
-            'raw' : ['pmtudisc'], # parameters that we can pass raw to ip command
-        },
-    }
-
-class IPIP6If(_Tunnel):
-    """
-    IPIP6: IPv4 over IPv6 tunnel
-
-    For more information please refer to:
-    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/link_ip6tnl.c
-    """
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'ipip6',
-            'encaplimit': '',
-            'hoplimit': '',
-            'tclass': '',
-            'flowlabel': '',
-        },
-    }
-
-class IP6IP6If(IPIP6If):
-    """
-    IP6IP6: IPv6 over IPv6 tunnel
-
-    For more information please refer to:
-    https://tools.ietf.org/html/rfc2473
-    """
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'ip6ip6',
-        },
-    }
-
-
-class SitIf(_Tunnel):
-    """
-    Sit: Simple Internet Transition
-
-    For more information please refer to:
-    https://git.kernel.org/pub/scm/network/iproute2/iproute2.git/tree/ip/link_iptnl.c
-    """
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': 'sit',
-        },
-    }
-
-class Sit6RDIf(SitIf):
-    """
-    Sit6RDIf: Simple Internet Transition with 6RD
-
-    https://en.wikipedia.org/wiki/IPv6_rapid_deployment
-    """
-    # TODO: check if key can really be used with 6RD
-    default = {
-        **_Tunnel.default,
-        **{
-            'type': '6rd',
-            '6rd_prefix' : '',
-            '6rd_relay_prefix' : '',
-        },
-    }
-
-    def _create(self):
-        # do not call _Tunnel.create, building fully here
-
-        create = 'ip tunnel add {ifname} mode {type} remote {remote}'
-        self._cmd(create.format(**self.config))
-        self.set_interface('state','down')
-
-        set6rd = 'ip tunnel 6rd dev {ifname} 6rd-prefix {6rd-prefix}'
-        if '6rd-relay-prefix' in self.config:
-            set6rd += ' 6rd-relay-prefix {6rd-relay-prefix}'
-        self._cmd(set6rd.format(**self.config))