dissect.target 3.11.dev21__tar.gz → 3.11.dev22__tar.gz

{dissect.target-3.11.dev21/dissect.target.egg-info → dissect.target-3.11.dev22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.11.dev21
+Version: 3.11.dev22
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect.target-3.11.dev21 → dissect.target-3.11.dev22}/dissect/target/plugins/os/unix/services.py

@@ -1,6 +1,8 @@
+import io
 import re
+from configparser import ConfigParser
 from itertools import chain
-from typing import BinaryIO, Iterator
+from typing import Iterator, TextIO
 
 from dissect.target.exceptions import FileNotFoundError, UnsupportedPluginError
 from dissect.target.helpers.record import TargetRecordDescriptor
@@ -51,30 +53,29 @@ class ServicesPlugin(Plugin):
             if not path.exists() or not path.is_dir():
                 continue
 
-            for file_ in path.iterdir():
-                if should_ignore_file(file_.name, ignored_suffixes):
+            for service_file in path.iterdir():
+                if should_ignore_file(service_file.name, ignored_suffixes):
                     continue
 
                 try:
-                    fh = file_.open("rt")
+                    with service_file.open("rt") as fh:
+                        config = parse_systemd_config(fh)
                 except FileNotFoundError:
                     # The service is registered but the symlink is broken.
                     yield LinuxServiceRecord(
-                        ts=file_.stat(follow_symlinks=False).st_mtime,
-                        name=file_.name,
+                        ts=service_file.stat(follow_symlinks=False).st_mtime,
+                        name=service_file.name,
                         config=None,
-                        source=file_,
+                        source=service_file,
                         _target=self.target,
                     )
                     continue
 
-                config = parse_systemd_config(fh)
-
                 yield LinuxServiceRecord(
-                    ts=file_.stat().st_mtime,
-                    name=file_.name,
+                    ts=service_file.stat().st_mtime,
+                    name=service_file.name,
                     config=config,
-                    source=file_,
+                    source=service_file,
                     _target=self.target,
                 )
 
@@ -106,43 +107,45 @@ def should_ignore_file(needle: str, haystack: list) -> bool:
     return False
 
 
-def parse_systemd_config(fh: BinaryIO) -> str:
+def parse_systemd_config(fh: TextIO) -> str:
     """Returns a string of key/value pairs from a toml/ini-like string.
 
     This should probably be rewritten to return a proper dict as in
     its current form this is only useful when used in Splunk.
     """
-    variables = ""
+    parser = ConfigParser(strict=False, delimiters=("=",), allow_no_value=True)
+    # to preserve casing from configuration.
+    parser.optionxform = str
+    parser.read_file(fh)
 
+    output = io.StringIO()
     try:
-        for line in fh:
-            line = line.strip().replace("\n", "")
-
-            # segment start eg. [ExampleSegment]
-            if line[:1] == "[":
-                segment = re.sub(r"\[|\]", "", line)
-
-            # ignore comments and empty lines
-            elif line[:1] == ";" or line[:1] == "#" or line == "":
-                continue
-
-            # if line ends with \ it is likely part of a multi-line command argument
-            elif line[-1] == "\\" or line[-1] == "'":
-                variables = f"{variables} {line} "
-
-            else:
-                line = line.split("=", 1)
-                if "segment" in locals():
-                    # some variables/arguments are not delimited by a '='
-                    # (eg. '-Kvalue' instead of '-key=value')
-                    if len(line) < 2:
-                        variables = f"{variables} {segment}_{line[0]} "
-                    else:
-                        variables = f'{variables} {segment}_{line[0]}="{line[1]}" '
+        for segment, configuration in parser.items():
+            original_key = ""
+            previous_value = ""
+            concat_value = False
+            for key, value in configuration.items():
+                original_key = original_key or key
+
+                if concat_value:
+                    # A backslash was found at the end of the previous line
+                    # If value is None, it might not contain a backslash
+                    # So we turn it into an empty string.
+                    value = f"{previous_value} {key} {value or ''}".strip()
+
+                concat_value = str(value).endswith("\\")
+                if concat_value:
+                    # Remove any dangling empty space or backslashes
+                    previous_value = value.rstrip("\\ ")
                 else:
-                    variables = f"{variables} {line} ".strip()
+                    output.write(f'{segment}_{original_key or key}="{value}" ')
+                    original_key = ""
+                    previous_value = ""
 
     except UnicodeDecodeError:
         pass
 
-    return variables.strip()
+    output_data = output.getvalue()
+    # Remove any back slashes or new line characters.
+    output_data = re.sub(r"(\\|\n)", "", output_data)
+    return output_data.strip()

{dissect.target-3.11.dev21 → dissect.target-3.11.dev22/dissect.target.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.11.dev21
+Version: 3.11.dev22
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

dissect.target-3.11.dev22/tests/test_plugins_os_unix_services.py

@@ -0,0 +1,75 @@
+import textwrap
+from io import StringIO
+
+import pytest
+
+from dissect.target.plugins.os.unix.services import ServicesPlugin, parse_systemd_config
+
+from ._utils import absolute_path
+
+
+def test_unix_services(target_unix_users, fs_unix):
+    systemd_service_1 = absolute_path("data/plugins/os/unix/services/systemd.service")
+    systemd_service_2 = absolute_path("data/plugins/os/unix/services/systemd2.service")
+    initd_service_1 = absolute_path("data/plugins/os/unix/services/initd.sh")
+    fs_unix.map_file("/lib/systemd/system/example.service", systemd_service_1)
+    fs_unix.symlink("/dev/null", "/lib/systemd/system/broken_sym_example.service")
+    fs_unix.map_file("/usr/lib/systemd/system/example2.service", systemd_service_2)
+    fs_unix.map_file("/etc/init.d/example", initd_service_1)
+    target_unix_users.add_plugin(ServicesPlugin)
+
+    results = list(target_unix_users.services())
+    assert len(results) == 4
+
+    assert results[0].name == "example.service"
+    expected_config_1 = 'Unit_Description="an example systemd service" Unit_After="foobar.service" Unit_Requires="foo.service bar.service" Service_Type="simple" Service_ExecStart="/usr/sbin/simple-command --key value" Service_SyslogIdentifier="" Service_TimeoutStopSec="5" Install_WantedBy="multi-user.target" Install_Alias="example.service"'  # noqa E501
+    assert results[0].config == expected_config_1
+    assert str(results[0].source) == "/lib/systemd/system/example.service"
+
+    assert results[1].name == "broken_sym_example.service"
+    assert results[1].config is None
+    assert str(results[1].source) == "/lib/systemd/system/broken_sym_example.service"
+
+    assert results[2].name == "example2.service"
+    expected_config_2 = 'Unit_Description="an example systemd service" Unit_After="foobar.service" Unit_Requires="foo.service bar.service" Service_Type="simple" Service_ExecStart="/bin/bash -c \'exec /usr/bin/example param1 --param2=value2 -P3value3 -param4 value4; exit 0\'" Service_SyslogIdentifier="example-service" Service_TimeoutStopSec="5" Install_WantedBy="multi-user.target" Install_Alias="example.service"'  # noqa E501
+    assert results[2].config == expected_config_2
+    assert str(results[2].source) == "/usr/lib/systemd/system/example2.service"
+
+    assert results[3].name == "example"
+    assert results[3].config is None
+    assert str(results[3].source) == "/etc/init.d/example"
+
+
+@pytest.mark.parametrize(
+    "assignment, expected_value",
+    [
+        ("[Unit]\nsystemd = help:me", 'Unit_systemd="help:me"'),
+        ("[Unit]\nhelp:me = systemd", 'Unit_help:me="systemd"'),
+        ("[Unit]\nempty_value=", 'Unit_empty_value=""'),
+        ("[Unit]\nnew_lines=hello \\\nworld", 'Unit_new_lines="hello world"'),
+        ("[Unit]\nnew_lines=hello \\\nworld\\\ntest", 'Unit_new_lines="hello world test"'),
+        ("[Unit]\ntest", 'Unit_test="None"'),
+        ("[Unit]\nnew_lines=hello \\\n#Comment\n;Comment2\nworld", 'Unit_new_lines="hello world"'),
+        ("[Unit]\nlines=hello \\\nworld\\\n\ntest", 'Unit_lines="hello world test"'),
+    ],
+)
+def test_unix_systemd_parser(assignment, expected_value):
+    data = parse_systemd_config(StringIO(assignment))
+    assert data == expected_value
+
+
+@pytest.mark.xfail
+def test_unix_systemd_known_fails():
+    # While this should return `Hello world test help`,
+    # the configparser attempts to append `help` as a value to the list of options
+    # belonging to the key before it `test\\`.
+    # However, `test\\` is `None` or empty in this case it attempts to append on a NoneType object.
+    # The future fix would to create a custom Systemd ConfigParser
+    systemd_config = """
+    [Unit]
+    new_lines=hello \\
+    world\\
+    test\\
+     help
+    """
+    parse_systemd_config(StringIO(textwrap.dedent(systemd_config)))

dissect.target-3.11.dev21/tests/test_plugins_os_unix_services.py

@@ -1,35 +0,0 @@
-from dissect.target.plugins.os.unix.services import ServicesPlugin
-
-from ._utils import absolute_path
-
-
-def test_unix_services(target_unix_users, fs_unix):
-    systemd_service_1 = absolute_path("data/plugins/os/unix/services/systemd.service")
-    systemd_service_2 = absolute_path("data/plugins/os/unix/services/systemd2.service")
-    initd_service_1 = absolute_path("data/plugins/os/unix/services/initd.sh")
-    fs_unix.map_file("/lib/systemd/system/example.service", systemd_service_1)
-    fs_unix.symlink("/dev/null", "/lib/systemd/system/broken_sym_example.service")
-    fs_unix.map_file("/usr/lib/systemd/system/example2.service", systemd_service_2)
-    fs_unix.map_file("/etc/init.d/example", initd_service_1)
-    target_unix_users.add_plugin(ServicesPlugin)
-
-    results = list(target_unix_users.services())
-    assert len(results) == 4
-
-    assert results[0].name == "example.service"
-    expected_config_1 = 'Unit_Description="an example systemd service"  Unit_After="foobar.service"  Unit_Requires="foo.service bar.service"  Service_Type="simple"  Service_ExecStart="/usr/sbin/simple-command --key value"  Service_SyslogIdentifier=""  Service_TimeoutStopSec="5"  Install_WantedBy="multi-user.target"  Install_Alias="example.service"'  # noqa E501
-    assert results[0].config == expected_config_1
-    assert str(results[0].source) == "/lib/systemd/system/example.service"
-
-    assert results[1].name == "broken_sym_example.service"
-    assert results[1].config is None
-    assert str(results[1].source) == "/lib/systemd/system/broken_sym_example.service"
-
-    assert results[2].name == "example2.service"
-    expected_config_2 = 'Unit_Description="an example systemd service"  Unit_After="foobar.service"  Unit_Requires="foo.service bar.service"  Service_Type="simple"  ExecStart=/bin/bash -c \'exec /usr/bin/example param1 --param2=value2 -P3value3 -param4 value4; \\  exit 0\'  Service_SyslogIdentifier="example-service"  Service_TimeoutStopSec="5"  Install_WantedBy="multi-user.target"  Install_Alias="example.service"'  # noqa E501
-    assert results[2].config == expected_config_2
-    assert str(results[2].source) == "/usr/lib/systemd/system/example2.service"
-
-    assert results[3].name == "example"
-    assert results[3].config is None
-    assert str(results[3].source) == "/etc/init.d/example"