From a22a059e36ec56d0d6d7e2a63ccff56d6c19f9d6 Mon Sep 17 00:00:00 2001

From: Eduardo Otubo <otubo@redhat.com>

Date: Mon, 4 May 2020 12:39:55 +0200

Subject: [PATCH 2/6] net/sysconfig: Handle default route setup for dhcp

 configured NICs

RH-Author: Eduardo Otubo <otubo@redhat.com>

Message-id: <20200327152826.13343-3-otubo@redhat.com>

Patchwork-id: 94457

O-Subject: [RHEL-8.1.z/RHEL-8.2.z cloud-init PATCHv2 2/6] net/sysconfig: Handle default route setup for dhcp configured NICs

Bugzilla: 1811753

RH-Acked-by: Cathy Avery <cavery@redhat.com>

RH-Acked-by: Vitaly Kuznetsov <vkuznets@redhat.com>

commit 3acaacc92be1b7d7bad099c323d6e923664a8afa

Author: Robert Schweikert <rjschwei@suse.com>

Date:   Tue Mar 12 21:08:22 2019 +0000

    net/sysconfig: Handle default route setup for dhcp configured NICs

    When the network configuration has a default route configured and

    another network device that is configured with dhcp, SUSE sysconfig

    output should not accept the default route provided by the dhcp

    server.

    LP: #1812117

Signed-off-by: Eduardo Otubo <otubo@redhat.com>

Signed-off-by: Miroslav Rezanina <mrezanin@redhat.com>

---

 cloudinit/net/network_state.py | 41 +++++++++++++++++++++------

 cloudinit/net/sysconfig.py     | 31 +++++++++++++++------

 tests/unittests/test_net.py    | 63 ++++++++++++++++++++++++++++++++++++++++++

 3 files changed, 118 insertions(+), 17 deletions(-)

diff --git a/cloudinit/net/network_state.py b/cloudinit/net/network_state.py

index 539b76d..4d19f56 100644

--- a/cloudinit/net/network_state.py

+++ b/cloudinit/net/network_state.py

@@ -148,6 +148,7 @@ class NetworkState(object):

         self._network_state = copy.deepcopy(network_state)

         self._version = version

         self.use_ipv6 = network_state.get('use_ipv6', False)

+        self._has_default_route = None

     @property

     def config(self):

@@ -157,14 +158,6 @@ class NetworkState(object):

     def version(self):

         return self._version

-    def iter_routes(self, filter_func=None):

-        for route in self._network_state.get('routes', []):

-            if filter_func is not None:

-                if filter_func(route):

-                    yield route

-            else:

-                yield route

-

     @property

     def dns_nameservers(self):

         try:

@@ -179,6 +172,12 @@ class NetworkState(object):

         except KeyError:

             return []

+    @property

+    def has_default_route(self):

+        if self._has_default_route is None:

+            self._has_default_route = self._maybe_has_default_route()

+        return self._has_default_route

+

     def iter_interfaces(self, filter_func=None):

         ifaces = self._network_state.get('interfaces', {})

         for iface in six.itervalues(ifaces):

@@ -188,6 +187,32 @@ class NetworkState(object):

                 if filter_func(iface):

                     yield iface

+    def iter_routes(self, filter_func=None):

+        for route in self._network_state.get('routes', []):

+            if filter_func is not None:

+                if filter_func(route):

+                    yield route

+            else:

+                yield route

+

+    def _maybe_has_default_route(self):

+        for route in self.iter_routes():

+            if self._is_default_route(route):

+                return True

+        for iface in self.iter_interfaces():

+            for subnet in iface.get('subnets', []):

+                for route in subnet.get('routes', []):

+                    if self._is_default_route(route):

+                        return True

+        return False

+

+    def _is_default_route(self, route):

+        default_nets = ('::', '0.0.0.0')

+        return (

+            route.get('prefix') == 0

+            and route.get('network') in default_nets

+            )

+

 @six.add_metaclass(CommandHandlerMeta)

 class NetworkStateInterpreter(object):

diff --git a/cloudinit/net/sysconfig.py b/cloudinit/net/sysconfig.py

index 52bb848..5c1b4eb 100644

--- a/cloudinit/net/sysconfig.py

+++ b/cloudinit/net/sysconfig.py

@@ -320,7 +320,7 @@ class Renderer(renderer.Renderer):

                 iface_cfg[new_key] = old_value

     @classmethod

-    def _render_subnets(cls, iface_cfg, subnets):

+    def _render_subnets(cls, iface_cfg, subnets, has_default_route):

         # setting base values

         iface_cfg['BOOTPROTO'] = 'none'

@@ -329,6 +329,7 @@ class Renderer(renderer.Renderer):

             mtu_key = 'MTU'

             subnet_type = subnet.get('type')

             if subnet_type == 'dhcp6':

+                # TODO need to set BOOTPROTO to dhcp6 on SUSE

                 iface_cfg['IPV6INIT'] = True

                 iface_cfg['DHCPV6C'] = True

             elif subnet_type in ['dhcp4', 'dhcp']:

@@ -372,9 +373,9 @@ class Renderer(renderer.Renderer):

         ipv6_index = -1

         for i, subnet in enumerate(subnets, start=len(iface_cfg.children)):

             subnet_type = subnet.get('type')

-            if subnet_type == 'dhcp6':

-                continue

-            elif subnet_type in ['dhcp4', 'dhcp']:

+            if subnet_type in ['dhcp', 'dhcp4', 'dhcp6']:

+                if has_default_route and iface_cfg['BOOTPROTO'] != 'none':

+                    iface_cfg['DHCLIENT_SET_DEFAULT_ROUTE'] = False

                 continue

             elif subnet_type == 'static':

                 if subnet_is_ipv6(subnet):

@@ -440,6 +441,8 @@ class Renderer(renderer.Renderer):

                     # TODO(harlowja): add validation that no other iface has

                     # also provided the default route?

                     iface_cfg['DEFROUTE'] = True

+                    if iface_cfg['BOOTPROTO'] in ('dhcp', 'dhcp4', 'dhcp6'):

+                        iface_cfg['DHCLIENT_SET_DEFAULT_ROUTE'] = True

                     if 'gateway' in route:

                         if is_ipv6 or is_ipv6_addr(route['gateway']):

                             iface_cfg['IPV6_DEFAULTGW'] = route['gateway']

@@ -490,7 +493,9 @@ class Renderer(renderer.Renderer):

             iface_cfg = iface_contents[iface_name]

             route_cfg = iface_cfg.routes

-            cls._render_subnets(iface_cfg, iface_subnets)

+            cls._render_subnets(

+                iface_cfg, iface_subnets, network_state.has_default_route

+            )

             cls._render_subnet_routes(iface_cfg, route_cfg, iface_subnets)

     @classmethod

@@ -515,7 +520,9 @@ class Renderer(renderer.Renderer):

             iface_subnets = iface.get("subnets", [])

             route_cfg = iface_cfg.routes

-            cls._render_subnets(iface_cfg, iface_subnets)

+            cls._render_subnets(

+                iface_cfg, iface_subnets, network_state.has_default_route

+            )

             cls._render_subnet_routes(iface_cfg, route_cfg, iface_subnets)

             # iter_interfaces on network-state is not sorted to produce

@@ -544,7 +551,9 @@ class Renderer(renderer.Renderer):

             iface_subnets = iface.get("subnets", [])

             route_cfg = iface_cfg.routes

-            cls._render_subnets(iface_cfg, iface_subnets)

+            cls._render_subnets(

+                iface_cfg, iface_subnets, network_state.has_default_route

+            )

             cls._render_subnet_routes(iface_cfg, route_cfg, iface_subnets)

     @staticmethod

@@ -603,7 +612,9 @@ class Renderer(renderer.Renderer):

             iface_subnets = iface.get("subnets", [])

             route_cfg = iface_cfg.routes

-            cls._render_subnets(iface_cfg, iface_subnets)

+            cls._render_subnets(

+                iface_cfg, iface_subnets, network_state.has_default_route

+            )

             cls._render_subnet_routes(iface_cfg, route_cfg, iface_subnets)

     @classmethod

@@ -615,7 +626,9 @@ class Renderer(renderer.Renderer):

             iface_cfg.kind = 'infiniband'

             iface_subnets = iface.get("subnets", [])

             route_cfg = iface_cfg.routes

-            cls._render_subnets(iface_cfg, iface_subnets)

+            cls._render_subnets(

+                iface_cfg, iface_subnets, network_state.has_default_route

+            )

             cls._render_subnet_routes(iface_cfg, route_cfg, iface_subnets)

     @classmethod

diff --git a/tests/unittests/test_net.py b/tests/unittests/test_net.py

index 4224301..a975678 100644

--- a/tests/unittests/test_net.py

+++ b/tests/unittests/test_net.py

@@ -546,6 +546,7 @@ NETWORK_CONFIGS = {

                 BOOTPROTO=dhcp

                 DEFROUTE=yes

                 DEVICE=eth99

+                DHCLIENT_SET_DEFAULT_ROUTE=yes

                 DNS1=8.8.8.8

                 DNS2=8.8.4.4

                 DOMAIN="barley.maas sach.maas"

@@ -913,6 +914,7 @@ pre-down route del -net 10.0.0.0 netmask 255.0.0.0 gw 11.0.0.1 metric 3 || true

             'ifcfg-bond0.200': textwrap.dedent("""\

                 BOOTPROTO=dhcp

                 DEVICE=bond0.200

+                DHCLIENT_SET_DEFAULT_ROUTE=no

                 ONBOOT=yes

                 PHYSDEV=bond0

                 TYPE=Ethernet

@@ -996,6 +998,7 @@ pre-down route del -net 10.0.0.0 netmask 255.0.0.0 gw 11.0.0.1 metric 3 || true

             'ifcfg-eth5': textwrap.dedent("""\

                 BOOTPROTO=dhcp

                 DEVICE=eth5

+                DHCLIENT_SET_DEFAULT_ROUTE=no

                 HWADDR=98:bb:9f:2c:e8:8a

                 ONBOOT=no

                 TYPE=Ethernet

@@ -1624,6 +1627,23 @@ CONFIG_V1_SIMPLE_SUBNET = {

                              'type': 'static'}],

                 'type': 'physical'}]}

+CONFIG_V1_MULTI_IFACE = {

+    'version': 1,

+    'config': [{'type': 'physical',

+                'mtu': 1500,

+                'subnets': [{'type': 'static',

+                             'netmask': '255.255.240.0',

+                             'routes': [{'netmask': '0.0.0.0',

+                                         'network': '0.0.0.0',

+                                         'gateway': '51.68.80.1'}],

+                             'address': '51.68.89.122',

+                             'ipv4': True}],

+                'mac_address': 'fa:16:3e:25:b4:59',

+                'name': 'eth0'},

+               {'type': 'physical',

+                'mtu': 9000,

+                'subnets': [{'type': 'dhcp4'}],

+                'mac_address': 'fa:16:3e:b1:ca:29', 'name': 'eth1'}]}

 DEFAULT_DEV_ATTRS = {

     'eth1000': {

@@ -2088,6 +2108,49 @@ USERCTL=no

 """

         self.assertEqual(expected, found[nspath + 'ifcfg-interface0'])

+    def test_network_config_v1_multi_iface_samples(self):

+        ns = network_state.parse_net_config_data(CONFIG_V1_MULTI_IFACE)

+        render_dir = self.tmp_path("render")

+        os.makedirs(render_dir)

+        renderer = self._get_renderer()

+        renderer.render_network_state(ns, target=render_dir)

+        found = dir2dict(render_dir)

+        nspath = '/etc/sysconfig/network-scripts/'

+        self.assertNotIn(nspath + 'ifcfg-lo', found.keys())

+        expected_i1 = """\

+# Created by cloud-init on instance boot automatically, do not edit.

+#

+BOOTPROTO=none

+DEFROUTE=yes

+DEVICE=eth0

+GATEWAY=51.68.80.1

+HWADDR=fa:16:3e:25:b4:59

+IPADDR=51.68.89.122

+MTU=1500

+NETMASK=255.255.240.0

+NM_CONTROLLED=no

+ONBOOT=yes

+STARTMODE=auto

+TYPE=Ethernet

+USERCTL=no

+"""

+        self.assertEqual(expected_i1, found[nspath + 'ifcfg-eth0'])

+        expected_i2 = """\

+# Created by cloud-init on instance boot automatically, do not edit.

+#

+BOOTPROTO=dhcp

+DEVICE=eth1

+DHCLIENT_SET_DEFAULT_ROUTE=no

+HWADDR=fa:16:3e:b1:ca:29

+MTU=9000

+NM_CONTROLLED=no

+ONBOOT=yes

+STARTMODE=auto

+TYPE=Ethernet

+USERCTL=no

+"""

+        self.assertEqual(expected_i2, found[nspath + 'ifcfg-eth1'])

+

     def test_config_with_explicit_loopback(self):

         ns = network_state.parse_net_config_data(CONFIG_V1_EXPLICIT_LOOPBACK)

         render_dir = self.tmp_path("render")

-- 

1.8.3.1