3004: Ignore non utf8 characters while reading files with core grains module

changelog/62633.fixed

@@ -0,0 +1 @@
+Prevent possible tracebacks in core grains module by ignoring non utf8 characters in /proc/1/environ, /proc/1/cmdline, /proc/cmdline

salt/grains/core.py

@@ -1093,7 +1093,9 @@ def _virtual(osdata):
         if ("virtual_subtype" not in grains) or (grains["virtual_subtype"] != "LXC"):
             if os.path.isfile("/proc/1/environ"):
                 try:
-                    with salt.utils.files.fopen("/proc/1/environ", "r") as fhr:
+                    with salt.utils.files.fopen(
+                        "/proc/1/environ", "r", errors="ignore"
+                    ) as fhr:
                         fhr_contents = fhr.read()
                     if "container=lxc" in fhr_contents:
                         grains["virtual"] = "container"
@@ -1911,7 +1913,9 @@ def os_data():
             grains["init"] = "systemd"
         except OSError:
             try:
-                with salt.utils.files.fopen("/proc/1/cmdline") as fhr:
+                with salt.utils.files.fopen(
+                    "/proc/1/cmdline", "r", errors="ignore"
+                ) as fhr:
                     init_cmdline = fhr.read().replace("\x00", " ").split()
             except OSError:
                 pass
@@ -3160,7 +3164,9 @@ def kernelparams():
         return {}
     else:
         try:
-            with salt.utils.files.fopen("/proc/cmdline", "r") as fhr:
+            with salt.utils.files.fopen(
+                "/proc/cmdline", "r", errors="surrogateescape"
+            ) as fhr:
                 cmdline = fhr.read()
                 grains = {"kernelparams": []}
                 for data in [

tests/pytests/unit/grains/proc-files/cmdline

@@ -0,0 +1 @@
+TEST_KEY1=VAL1 TEST_KEY2=VAL2 BOOTABLE_FLAG="�" TEST_KEY_NOVAL TEST_KEY3=3

tests/pytests/unit/grains/proc-files/environ

@@ -0,0 +1 @@
+KEY1=VAL1 KEY2=VAL2  KEY2=VAL2

tests/pytests/unit/grains/test_core.py

@@ -2635,6 +2635,30 @@ def test_kernelparams_return_linux(cmdline, expectation):
         assert core.kernelparams() == expectation
 
 
+@pytest.mark.skip_unless_on_linux
+def test_kernelparams_return_linux_non_utf8():
+    _salt_utils_files_fopen = salt.utils.files.fopen
+
+    def _open_mock(file_name, *args, **kwargs):
+        return _salt_utils_files_fopen(
+            pathlib.Path(__file__).parent.joinpath("proc-files").joinpath("cmdline"),
+            *args,
+            **kwargs
+        )
+
+    expected = {
+        "kernelparams": [
+            ("TEST_KEY1", "VAL1"),
+            ("TEST_KEY2", "VAL2"),
+            ("BOOTABLE_FLAG", "\udc80"),
+            ("TEST_KEY_NOVAL", None),
+            ("TEST_KEY3", "3"),
+        ]
+    }
+    with patch("salt.utils.files.fopen", _open_mock):
+        assert core.kernelparams() == expected
+
+
 def test_linux_gpus():
     """
     Test GPU detection on Linux systems
@@ -2837,3 +2861,74 @@ def test_virtual_set_virtual_ec2():
 
         assert virtual_grains["virtual"] == "kvm"
         assert "virtual_subtype" not in virtual_grains
+
+
+@pytest.mark.skip_on_windows
+def test_linux_proc_files_with_non_utf8_chars():
+    _salt_utils_files_fopen = salt.utils.files.fopen
+
+    def _mock_open(filename, *args, **kwargs):
+        return _salt_utils_files_fopen(
+            pathlib.Path(__file__).parent.joinpath("proc-files").joinpath("cmdline-1"),
+            *args,
+            **kwargs
+        )
+
+    empty_mock = MagicMock(return_value={})
+
+    with patch("os.path.isfile", return_value=False), patch(
+        "salt.utils.files.fopen", _mock_open
+    ), patch.dict(
+        core.__salt__,
+        {
+            "cmd.retcode": salt.modules.cmdmod.retcode,
+            "cmd.run": MagicMock(return_value=""),
+        },
+    ), patch.object(
+        core, "_linux_bin_exists", return_value=False
+    ), patch.object(
+        core, "_parse_lsb_release", return_value=empty_mock
+    ), patch.object(
+        core, "_parse_os_release", return_value=empty_mock
+    ), patch.object(
+        core, "_hw_data", return_value=empty_mock
+    ), patch.object(
+        core, "_virtual", return_value=empty_mock
+    ), patch.object(
+        core, "_bsd_cpudata", return_value=empty_mock
+    ), patch.object(
+        os, "stat", side_effect=OSError()
+    ):
+        os_grains = core.os_data()
+        assert os_grains != {}
+
+
+@pytest.mark.skip_on_windows
+def test_virtual_linux_proc_files_with_non_utf8_chars():
+    _salt_utils_files_fopen = salt.utils.files.fopen
+
+    def _mock_open(filename, *args, **kwargs):
+        return _salt_utils_files_fopen(
+            pathlib.Path(__file__).parent.joinpath("proc-files").joinpath("environ"),
+            *args,
+            **kwargs
+        )
+
+    def _is_file_mock(filename):
+        if filename == "/proc/1/environ":
+            return True
+        return False
+
+    with patch("os.path.isfile", _is_file_mock), patch(
+        "salt.utils.files.fopen", _mock_open
+    ), patch.object(salt.utils.path, "which", MagicMock(return_value=None)), patch.dict(
+        core.__salt__,
+        {
+            "cmd.run_all": MagicMock(
+                return_value={"retcode": 1, "stderr": "", "stdout": ""}
+            ),
+            "cmd.run": MagicMock(return_value=""),
+        },
+    ):
+        virt_grains = core._virtual({"kernel": "Linux"})
+        assert virt_grains == {"virtual": "physical"}