Merge pull request #118 from c-po/pyroute2

loopback: T1601: migrate to pyroute2

3 files changed, 26 insertions, 190 deletions

diff --git a/python/vyos/configinterface.py b/python/vyos/configinterface.py
deleted file mode 100644
index 188d5b9e2..000000000
--- a/python/vyos/configinterface.py
+++ /dev/null
@@ -1,172 +0,0 @@
-# Copyright 2019 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
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import vyos.validate
-
-def validate_mac_address(addr):
-    # a mac address consits out of 6 octets
-    octets = len(addr.split(':'))
-    if octets != 6:
-        raise ValueError('wrong number of MAC octets: {} '.format(octets))
-
-    # validate against the first mac address byte if it's a multicast address
-    if int(addr.split(':')[0]) & 1:
-        raise ValueError('{} is a multicast MAC address'.format(addr))
-
-    # overall mac address is not allowed to be 00:00:00:00:00:00
-    if sum(int(i, 16) for i in addr.split(':')) == 0:
-        raise ValueError('00:00:00:00:00:00 is not a valid MAC address')
-
-    # check for VRRP mac address
-    if addr.split(':')[0] == '0' and addr.split(':')[1] == '0' and addr.split(':')[2] == '94' and addr.split(':')[3] == '0' and addr.split(':')[4] == '1':
-        raise ValueError('{} is a VRRP MAC address')
-
-    pass
-
-def set_mac_address(intf, addr):
-    """
-    Configure interface mac address using iproute2 command
-    """
-    validate_mac_address(addr)
-
-    os.system('ip link set {} address {}'.format(intf, addr))
-    pass
-
-def set_description(intf, desc):
-    """
-    Sets the interface secription reported usually by SNMP
-    """
-    with open('/sys/class/net/' + intf + '/ifalias', 'w') as f:
-      f.write(desc)
-
-    pass
-
-def set_arp_cache_timeout(intf, tmoMS):
-    """
-    Configure the ARP cache entry timeout in milliseconds
-    """
-    with open('/proc/sys/net/ipv4/neigh/' + intf + '/base_reachable_time_ms', 'w') as f:
-      f.write(tmoMS)
-
-    pass
-
-def set_multicast_querier(intf, enable):
-    """
-    Sets whether the bridge actively runs a multicast querier or not. When a
-    bridge receives a 'multicast host membership' query from another network host,
-    that host is tracked based on the time that the query was received plus the
-    multicast query interval time.
-
-    use enable=1 to enable or enable=0 to disable
-    """
-
-    if int(enable) >= 0 and int(enable) <= 1:
-      with open('/sys/devices/virtual/net/' + intf + '/bridge/multicast_querier', 'w') as f:
-        f.write(str(enable))
-    else:
-      raise ValueError("malformed configuration string on interface {}: enable={}".format(intf, enable))
-
-    pass
-
-def set_link_detect(intf, enable):
-    """
-    0 - Allow packets to be received for the address on this interface
-    even if interface is disabled or no carrier.
-
-    1 - Ignore packets received if interface associated with the incoming
-    address is down.
-
-    2 - Ignore packets received if interface associated with the incoming
-    address is down or has no carrier.
-
-    Kernel Source: Documentation/networking/ip-sysctl.txt
-    """
-
-    # Note can't use sysctl it is broken for vif name because of dots
-    # link_filter values:
-    #   0 - always receive
-    #   1 - ignore receive if admin_down
-    #   2 - ignore receive if admin_down or link down
-
-    with open('/proc/sys/net/ipv4/conf/' + intf + '/link_filter', 'w') as f:
-      if enable == True or enable == 1:
-        f.write('2')
-        if os.path.isfile('/usr/bin/vtysh'):
-          os.system('/usr/bin/vtysh -c "configure terminal" -c "interface {}" -c "link-detect"'.format(intf))
-      else:
-        f.write('1')
-        if os.path.isfile('/usr/bin/vtysh'):
-          os.system('/usr/bin/vtysh -c "configure terminal" -c "interface {}" -c "no link-detect"'.format(intf))
-
-    pass
-
-def add_interface_address(intf, addr):
-    """
-    Configure an interface IPv4/IPv6 address
-    """
-    if addr == "dhcp":
-        os.system('/opt/vyatta/sbin/vyatta-interfaces.pl --dev="{}" --dhcp=start'.format(intf))
-    elif addr == "dhcpv6":
-        os.system('/opt/vyatta/sbin/vyatta-dhcpv6-client.pl --start -ifname "{}"'.format(intf))
-    elif vyos.validate.is_ipv4(addr):
-        if not vyos.validate.is_intf_addr_assigned(intf, addr):
-            os.system('sudo ip -4 addr add "{}" broadcast + dev "{}"'.format(addr, intf))
-    elif vyos.validate.is_ipv6(addr):
-        if not vyos.validate.is_intf_addr_assigned(intf, addr):
-            os.system('sudo ip -6 addr add "{}" dev "{}"'.format(addr, intf))
-    else:
-        raise ConfigError('{} is not a valid interface address'.format(addr))
-
-    pass
-
-def remove_interface_address(intf, addr):
-    """
-    Remove IPv4/IPv6 address from given interface
-    """
-
-    if addr == "dhcp":
-        os.system('/opt/vyatta/sbin/vyatta-interfaces.pl --dev="{}" --dhcp=stop'.format(intf))
-    elif addr == "dhcpv6":
-        os.system('/opt/vyatta/sbin/vyatta-dhcpv6-client.pl --stop -ifname "{}"'.format(intf))
-    elif vyos.validate.is_ipv4(addr):
-        os.system('ip -4 addr del "{}" dev "{}"'.format(addr, intf))
-    elif vyos.validate.is_ipv6(addr):
-        os.system('ip -6 addr del "{}" dev "{}"'.format(addr, intf))
-    else:
-        raise ConfigError('{} is not a valid interface address'.format(addr))
-
-    pass
-
-def remove_interface(ifname):
-    """
-    Remove given interface from operating system, e.g. 'dum0'
-    """
-
-    if os.path.isdir('/sys/class/net/' + ifname):
-        os.system('ip link delete "{}"'.format(ifname))
-
-    pass
-
-def add_interface(type, ifname):
-    """
-    Add given interface to operating system, e.g. add 'dummy' interface with
-    name 'dum0'
-    """
-
-    if not os.path.isdir('/sys/class/net/' + ifname):
-        os.system('ip link add "{}" type "{}"'.format(ifname, type))
-
-    pass
diff --git a/src/conf_mode/interface-bridge.py b/src/conf_mode/interface-bridge.py
index d5ef85940..85ea68e26 100755
--- a/src/conf_mode/interface-bridge.py
+++ b/src/conf_mode/interface-bridge.py
@@ -247,7 +247,7 @@ def apply(bridge):
         if bridge['disable']:
             br.down()
 
-        # commit change son bridge interface
+        # commit changes on bridge interface
         br.commit()
 
         # configure additional bridge member options
diff --git a/src/conf_mode/interface-loopback.py b/src/conf_mode/interface-loopback.py
index 445a9af64..5c1419b11 100755
--- a/src/conf_mode/interface-loopback.py
+++ b/src/conf_mode/interface-loopback.py
@@ -14,14 +14,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
-#
-
-import os
-import sys
-import copy
-
-import vyos.configinterface as VyIfconfig
 
+from os import environ
+from sys import exit
+from copy import deepcopy
+from pyroute2 import IPDB
 from vyos.config import Config
 from vyos import ConfigError
 
@@ -37,12 +34,12 @@ def diff(first, second):
     return [item for item in first if item not in second]
 
 def get_config():
-    loopback = copy.deepcopy(default_config_data)
+    loopback = deepcopy(default_config_data)
     conf = Config()
 
     # determine tagNode instance
     try:
-        loopback['intf'] = os.environ['VYOS_TAGNODE_VALUE']
+        loopback['intf'] = environ['VYOS_TAGNODE_VALUE']
     except KeyError as E:
         print("Interface not specified")
 
@@ -60,6 +57,8 @@ def get_config():
     # retrieve interface description
     if conf.exists('description'):
         loopback['description'] = conf.return_value('description')
+    else:
+        loopback['description'] = loopback['intf']
 
     # Determine interface addresses (currently effective) - to determine which
     # address is no longer valid and needs to be removed from the interface
@@ -76,19 +75,28 @@ def generate(loopback):
     return None
 
 def apply(loopback):
-    # Remove loopback interface
+    ipdb = IPDB(mode='explicit')
+    lo_if = loopback['intf']
+
+    # the loopback device always exists
+    lo = ipdb.interfaces[lo_if]
+    # begin() a transaction prior to make any change
+    lo.begin()
+
     if not loopback['deleted']:
         # update interface description used e.g. within SNMP
-        VyIfconfig.set_description(loopback['intf'], loopback['description'])
-
-        # Configure interface address(es)
+        # update interface description used e.g. within SNMP
+        lo.ifalias = loopback['description']
+        # configure interface address(es)
         for addr in loopback['address']:
-            VyIfconfig.add_interface_address(loopback['intf'], addr)
+            lo.add_ip(addr)
 
-    # Remove interface address(es)
+    # remove interface address(es)
     for addr in loopback['address_remove']:
-        VyIfconfig.remove_interface_address(loopback['intf'], addr)
+        lo.del_ip(addr)
 
+    # commit changes on loopback interface
+    lo.commit()
     return None
 
 if __name__ == '__main__':
@@ -99,4 +107,4 @@ if __name__ == '__main__':
         apply(c)
     except ConfigError as e:
         print(e)
-        sys.exit(1)
+        exit(1)