From 8e3a949705a727a36eb2335aebc0b874bda82f09 Mon Sep 17 00:00:00 2001 From: sxt1001 Date: Thu, 5 Jan 2023 16:38:15 +0800 Subject: [PATCH] Limit permissions for /etc/network/50-cloud-init.yaml as read-only for root (600) --- ...ig-root-read-only-as-wifi-config-can.patch | 94 ++++++++++ ...eatures.NETPLAN_CONFIG_ROOT_READ_ONL.patch | 177 ++++++++++++++++++ cloud-init.spec | 7 +- 3 files changed, 277 insertions(+), 1 deletion(-) create mode 100644 backport-net-netplan-config-root-read-only-as-wifi-config-can.patch create mode 100644 backport-netplan-define-features.NETPLAN_CONFIG_ROOT_READ_ONL.patch diff --git a/backport-net-netplan-config-root-read-only-as-wifi-config-can.patch b/backport-net-netplan-config-root-read-only-as-wifi-config-can.patch new file mode 100644 index 0000000..5667e84 --- /dev/null +++ b/backport-net-netplan-config-root-read-only-as-wifi-config-can.patch @@ -0,0 +1,94 @@ +From bbf200f3b2f89ab540a31fb61cf0e6a1bc1cfd07 Mon Sep 17 00:00:00 2001 +From: Chad Smith +Date: Thu, 8 Dec 2022 22:03:46 -0700 +Subject: [PATCH] * net: netplan config root read-only as wifi config can + contain creds + +On netplan systems, network v2 is passed directly though and written +to /etc/netplan/50-cloud-init.yaml without validation. Current +netplan configuration provides the ability to configure sensitive +information such as `wifi:access-points:password`. + +Limit permissions for /etc/network/50-cloud-init.yaml as read-only +for root (600). Since configuration or modification or netplan config +needs to be performed by an admin user this permission restriction +aligns with netplan tooling. + +Set root read-only only always and not just 'if' sensitive material +exists within custom config because it will add confusion to have +two expected modes for this file based on external conditions. +--- + cloudinit/net/netplan.py | 3 ++- + tests/integration_tests/modules/test_combined.py | 11 +++++++++++ + tests/unittests/test_distros/test_netconfig.py | 5 +++-- + 3 files changed, 16 insertions(+), 3 deletions(-) + +diff --git a/cloudinit/net/netplan.py b/cloudinit/net/netplan.py +index 41acf96..72309fd 100644 +--- a/cloudinit/net/netplan.py ++++ b/cloudinit/net/netplan.py +@@ -234,7 +234,8 @@ class Renderer(renderer.Renderer): + + if not header.endswith("\n"): + header += "\n" +- util.write_file(fpnplan, header + content) ++ ++ util.write_file(fpnplan, header + content, mode=0o600) + + if self.clean_default: + _clean_default(target=target) +diff --git a/tests/integration_tests/modules/test_combined.py b/tests/integration_tests/modules/test_combined.py +index 9cd1648..bbf59bd 100644 +--- a/tests/integration_tests/modules/test_combined.py ++++ b/tests/integration_tests/modules/test_combined.py +@@ -41,6 +41,17 @@ runcmd: + @pytest.mark.ci + @pytest.mark.user_data(USER_DATA) + class TestCombined: ++ @pytest.mark.ubuntu # Because netplan ++ def test_netplan_permissions(self, class_client: IntegrationInstance): ++ """ ++ Test that netplan config file is generated with proper permissions ++ """ ++ response = class_client.execute( ++ "stat -c %a /etc/netplan/50-cloud-init.yaml" ++ ) ++ assert response.ok, "Unable to check perms on 50-cloud-init.yaml" ++ assert "600" == response.stdout.strip() ++ + def test_final_message(self, class_client: IntegrationInstance): + """Test that final_message module works as expected. + +diff --git a/tests/unittests/test_distros/test_netconfig.py b/tests/unittests/test_distros/test_netconfig.py +index d09e46a..37cfcdf 100644 +--- a/tests/unittests/test_distros/test_netconfig.py ++++ b/tests/unittests/test_distros/test_netconfig.py +@@ -431,7 +431,7 @@ class TestNetCfgDistroUbuntuNetplan(TestNetCfgDistroBase): + print(results[cfgpath]) + print("----------") + self.assertEqual(expected, results[cfgpath]) +- self.assertEqual(0o644, get_mode(cfgpath, tmpd)) ++ self.assertEqual(0o600, get_mode(cfgpath, tmpd)) + + def netplan_path(self): + return '/etc/netplan/50-cloud-init.yaml' +@@ -720,6 +720,7 @@ class TestNetCfgDistroArch(TestNetCfgDistroBase): + apply_fn(config, bringup) + + results = dir2dict(tmpd) ++ mode = 0o600 if with_netplan else 0o644 + for cfgpath, expected in expected_cfgs.items(): + print("----------") + print(expected) +@@ -727,7 +728,7 @@ class TestNetCfgDistroArch(TestNetCfgDistroBase): + print(results[cfgpath]) + print("----------") + self.assertEqual(expected, results[cfgpath]) +- self.assertEqual(0o644, get_mode(cfgpath, tmpd)) ++ self.assertEqual(mode, get_mode(cfgpath, tmpd)) + + def netctl_path(self, iface): + return '/etc/netctl/%s' % iface +-- +2.33.0 + diff --git a/backport-netplan-define-features.NETPLAN_CONFIG_ROOT_READ_ONL.patch b/backport-netplan-define-features.NETPLAN_CONFIG_ROOT_READ_ONL.patch new file mode 100644 index 0000000..f0c7fd6 --- /dev/null +++ b/backport-netplan-define-features.NETPLAN_CONFIG_ROOT_READ_ONL.patch @@ -0,0 +1,177 @@ +From 9e6f7ed6ed2b5dd25a51db057bc268ee7ae626bc Mon Sep 17 00:00:00 2001 +From: Chad Smith +Date: Mon, 12 Dec 2022 16:30:31 -0700 +Subject: [PATCH] netplan: define features.NETPLAN_CONFIG_ROOT_READ_ONLY +flag + +To make retaining original behavior in stable downstreams easier, +provide a feature flag NETPLAN_CONFIG_ROOT_READ_ONLY so +/etc/netplan/50-cloud-init.yaml config can remain unchanged as +world-readable. + +Set this flag False to ensure world-readable 50-cloud-init.yaml. + +Add tests.integration_tests.util.get_feature_flag to extract +feature values from cloudinit.features on test system. + +Co-authored-by: James Falcon +--- + cloudinit/features.py | 10 ++++++++++ + cloudinit/net/netplan.py | 4 +++- + .../modules/test_combined.py | 14 +++++++++++--- + tests/integration_tests/util.py | 10 ++++++++++ + .../unittests/test_distros/test_netconfig.py | 19 ++++++++++++++++++- + 5 files changed, 52 insertions(+), 5 deletions(-) + +diff --git a/cloudinit/features.py b/cloudinit/features.py +index e1116a1..25748e2 100644 +--- a/cloudinit/features.py ++++ b/cloudinit/features.py +@@ -49,6 +49,16 @@ mirrors via :py:mod:`apt: ` + directives in cloud-config. + """ + ++NETPLAN_CONFIG_ROOT_READ_ONLY = True ++""" ++If ``NETPLAN_CONFIG_ROOT_READ_ONLY`` is True, then netplan configuration will ++be written as a single root readon-only file /etc/netplan/50-cloud-init.yaml. ++This prevents wifi passwords in network v2 configuration from being ++world-readable. Prior to 23.1, netplan configuration is world-readable. ++ ++(This flag can be removed after Jammy is no longer supported.) ++""" ++ + try: + # pylint: disable=wildcard-import + from cloudinit.feature_overrides import * # noqa +diff --git a/cloudinit/net/netplan.py b/cloudinit/net/netplan.py +index 72309fd..6bb2cb5 100644 +--- a/cloudinit/net/netplan.py ++++ b/cloudinit/net/netplan.py +@@ -11,6 +11,7 @@ from .network_state import ( + IPV6_DYNAMIC_TYPES, + ) + ++from cloudinit import features + from cloudinit import log as logging + from cloudinit import util + from cloudinit import subp +@@ -235,7 +236,8 @@ class Renderer(renderer.Renderer): + if not header.endswith("\n"): + header += "\n" + +- util.write_file(fpnplan, header + content, mode=0o600) ++ mode = 0o600 if features.NETPLAN_CONFIG_ROOT_READ_ONLY else 0o644 ++ util.write_file(fpnplan, header + content, mode=mode) + + if self.clean_default: + _clean_default(target=target) +diff --git a/tests/integration_tests/modules/test_combined.py b/tests/integration_tests/modules/test_combined.py +index bbf59bd..e9a3e71 100644 +--- a/tests/integration_tests/modules/test_combined.py ++++ b/tests/integration_tests/modules/test_combined.py +@@ -9,9 +9,11 @@ import json + import pytest + import re + ++from cloudinit.util import is_true + from tests.integration_tests.clouds import ImageSpecification + from tests.integration_tests.instances import IntegrationInstance + from tests.integration_tests.util import ( ++ get_feature_flag_value, + verify_clean_log, + verify_ordered_items_in_text, + ) +@@ -46,11 +48,17 @@ class TestCombined: + """ + Test that netplan config file is generated with proper permissions + """ +- response = class_client.execute( ++ file_perms = class_client.execute( + "stat -c %a /etc/netplan/50-cloud-init.yaml" + ) +- assert response.ok, "Unable to check perms on 50-cloud-init.yaml" +- assert "600" == response.stdout.strip() ++ assert file_perms.ok, "Unable to check perms on 50-cloud-init.yaml" ++ feature_netplan_root_only = is_true( ++ get_feature_flag_value( ++ class_client, "NETPLAN_CONFIG_ROOT_READ_ONLY" ++ ) ++ ) ++ config_perms = "600" if feature_netplan_root_only else "644" ++ assert config_perms == file_perms.stdout.strip() + + def test_final_message(self, class_client: IntegrationInstance): + """Test that final_message module works as expected. +diff --git a/tests/integration_tests/util.py b/tests/integration_tests/util.py +index 407096c..29ee875 100644 +--- a/tests/integration_tests/util.py ++++ b/tests/integration_tests/util.py +@@ -128,3 +128,13 @@ def retry(*, tries: int = 30, delay: int = 1): + raise last_error + return wrapper + return _retry ++ ++ ++def get_feature_flag_value(client: IntegrationInstance, key): ++ value = client.execute( ++ 'python3 -c "from cloudinit import features; ' ++ f'print(features.{key})"' ++ ).strip() ++ if "NameError" in value: ++ raise NameError(f"name '{key}' is not defined") ++ return value +diff --git a/tests/unittests/test_distros/test_netconfig.py b/tests/unittests/test_distros/test_netconfig.py +index 37cfcdf..39de989 100644 +--- a/tests/unittests/test_distros/test_netconfig.py ++++ b/tests/unittests/test_distros/test_netconfig.py +@@ -11,6 +11,7 @@ from cloudinit import distros + from cloudinit.distros.parsers.sys_conf import SysConf + from cloudinit import helpers + from cloudinit import settings ++from cloudinit import features + from cloudinit.tests.helpers import ( + FilesystemMockingTestCase, dir2dict) + from cloudinit import subp +@@ -424,6 +425,8 @@ class TestNetCfgDistroUbuntuNetplan(TestNetCfgDistroBase): + apply_fn(config, bringup) + + results = dir2dict(tmpd) ++ ++ mode = 0o600 if features.NETPLAN_CONFIG_ROOT_READ_ONLY else 0o644 + for cfgpath, expected in expected_cfgs.items(): + print("----------") + print(expected) +@@ -431,7 +434,7 @@ class TestNetCfgDistroUbuntuNetplan(TestNetCfgDistroBase): + print(results[cfgpath]) + print("----------") + self.assertEqual(expected, results[cfgpath]) +- self.assertEqual(0o600, get_mode(cfgpath, tmpd)) ++ self.assertEqual(mode, get_mode(cfgpath, tmpd)) + + def netplan_path(self): + return '/etc/netplan/50-cloud-init.yaml' +@@ -465,6 +468,20 @@ class TestNetCfgDistroUbuntuNetplan(TestNetCfgDistroBase): + V2_NET_CFG, + expected_cfgs=expected_cfgs.copy()) + ++ def test_apply_network_config_v2_passthrough_ub_old_behavior(self): ++ """Kinetic and earlier have 50-cloud-init.yaml world-readable""" ++ expected_cfgs = { ++ self.netplan_path(): V2_TO_V2_NET_CFG_OUTPUT, ++ } ++ # ub_distro.apply_network_config(V2_NET_CFG, False) ++ with mock.patch.object( ++ features, "NETPLAN_CONFIG_ROOT_READ_ONLY", False ++ ): ++ self._apply_and_verify_netplan( ++ self.distro.apply_network_config, ++ V2_NET_CFG, ++ expected_cfgs=expected_cfgs.copy(), ++ ) + + class TestNetCfgDistroRedhat(TestNetCfgDistroBase): + +-- +2.33.0 + diff --git a/cloud-init.spec b/cloud-init.spec index 76b855e..9e43251 100644 --- a/cloud-init.spec +++ b/cloud-init.spec @@ -1,6 +1,6 @@ Name: cloud-init Version: 21.4 -Release: 5 +Release: 6 Summary: the defacto multi-distribution package that handles early initialization of a cloud instance. License: ASL 2.0 or GPLv3 URL: http://launchpad.net/cloud-init @@ -15,6 +15,8 @@ Patch3: bugfix-sort-requirements.patch Patch4: add-variable-to-forbid-tmp-dir.patch Patch5: backport-add-Requires-cloud-init-hotplugd.socket-in-cloud-init-hotplugd.service-file.patch Patch6: backport-testing-add-additional-mocks-to-test_net-tests-1356.patch +Patch7: backport-net-netplan-config-root-read-only-as-wifi-config-can.patch +Patch8: backport-netplan-define-features.NETPLAN_CONFIG_ROOT_READ_ONL.patch Patch9000: Fix-the-error-level-logs-displayed-for-the-cloud-init-local-service.patch @@ -126,6 +128,9 @@ fi %exclude /usr/share/doc/* %changelog +* Thu Jan 05 2023 shixuantong - 21.4-6 +- Limit permissions for /etc/network/50-cloud-init.yaml as read-only for root (600) + * Wed Nov 30 2022 shixuantong - 21.4-5 - rename patch -- Gitee