dissect.target 3.20.dev17__tar.gz → 3.20.dev19__tar.gz

{dissect_target-3.20.dev17/dissect.target.egg-info → dissect_target-3.20.dev19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.20.dev17
+Version: 3.20.dev19
 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.20.dev19/dissect/target/plugins/apps/virtualization/vmware_workstation.py

@@ -0,0 +1,61 @@
+from typing import Iterator
+
+from dissect.target.exceptions import UnsupportedPluginError
+from dissect.target.helpers.descriptor_extensions import UserRecordDescriptorExtension
+from dissect.target.helpers.fsutil import TargetPath
+from dissect.target.helpers.record import create_extended_descriptor
+from dissect.target.plugin import Plugin, alias, export
+from dissect.target.plugins.general.users import UserDetails
+from dissect.target.target import Target
+
+VmwareDragAndDropRecord = create_extended_descriptor([UserRecordDescriptorExtension])(
+    "virtualization/vmware/clipboard",
+    [
+        ("datetime", "ts"),
+        ("path", "path"),
+    ],
+)
+
+VMWARE_DND_PATHS = [
+    # Windows
+    "AppData/Local/Temp/VmwareDND",
+    # Linux
+    ".cache/vmware/drag_and_drop",
+]
+
+
+class VmwareWorkstationPlugin(Plugin):
+    """VMware Workstation plugin."""
+
+    __namespace__ = "vmware"
+
+    def __init__(self, target: Target):
+        super().__init__(target)
+        self.dnd_dirs = list(self.find_dnd_dirs())
+
+    def check_compatible(self) -> None:
+        if not self.dnd_dirs:
+            raise UnsupportedPluginError("No VMware Workstation DnD artifact(s) found")
+
+    def find_dnd_dirs(self) -> Iterator[tuple[UserDetails, TargetPath]]:
+        for user_details in self.target.user_details.all_with_home():
+            for dnd_path in VMWARE_DND_PATHS:
+                if (dnd_dir := user_details.home_path.joinpath(dnd_path)).exists():
+                    yield user_details, dnd_dir
+
+    @alias("draganddrop")
+    @export(record=VmwareDragAndDropRecord)
+    def clipboard(self) -> Iterator[VmwareDragAndDropRecord]:
+        """Yield cached VMware Workstation drag-and-drop file artifacts."""
+
+        for user_details, dnd_dir in self.dnd_dirs:
+            for file in dnd_dir.rglob("*/*"):
+                if file.is_dir():
+                    continue
+
+                yield VmwareDragAndDropRecord(
+                    ts=file.lstat().st_mtime,
+                    path=file,
+                    _user=user_details.user,
+                    _target=self.target,
+                )

{dissect_target-3.20.dev17 → dissect_target-3.20.dev19}/dissect/target/plugins/child/vmware_workstation.py

@@ -1,29 +1,44 @@
+from typing import Iterator
+
 from dissect.target.exceptions import UnsupportedPluginError
+from dissect.target.helpers.fsutil import TargetPath
 from dissect.target.helpers.record import ChildTargetRecord
 from dissect.target.plugin import ChildTargetPlugin
+from dissect.target.target import Target
+
+INVENTORY_PATHS = [
+    # Windows
+    "AppData/Roaming/VMware/inventory.vmls",
+    # Linux
+    ".vmware/inventory.vmls",
+]
+
+
+def find_vm_inventory(target: Target) -> Iterator[TargetPath]:
+    """Search for inventory.vmls files in user home folders.
 
+    Does not support older vmAutoStart.xml or vmInventory.xml formats."""
 
-def find_vm_inventory(target):
     for user_details in target.user_details.all_with_home():
-        inv_file = user_details.home_path.joinpath("AppData/Roaming/VMware/inventory.vmls")
-        if inv_file.exists():
-            yield inv_file
+        for inv_path in INVENTORY_PATHS:
+            if (inv_file := user_details.home_path.joinpath(inv_path)).exists():
+                yield inv_file
 
 
-class WorkstationChildTargetPlugin(ChildTargetPlugin):
+class VmwareWorkstationChildTargetPlugin(ChildTargetPlugin):
     """Child target plugin that yields from VMware Workstation VM inventory."""
 
     __type__ = "vmware_workstation"
 
-    def __init__(self, target):
+    def __init__(self, target: Target):
         super().__init__(target)
         self.inventories = list(find_vm_inventory(target))
 
     def check_compatible(self) -> None:
-        if not len(self.inventories):
+        if not self.inventories:
             raise UnsupportedPluginError("No VMWare inventories found")
 
-    def list_children(self):
+    def list_children(self) -> Iterator[ChildTargetRecord]:
         for inv in self.inventories:
             for line in inv.open("rt"):
                 line = line.strip()

{dissect_target-3.20.dev17 → dissect_target-3.20.dev19}/dissect/target/tools/shell.py

@@ -96,6 +96,7 @@ class ExtendedCmd(cmd.Cmd):
 
     CMD_PREFIX = "cmd_"
     _runtime_aliases = {}
+    DEFAULT_RUNCOMMANDS_FILE = None
 
     def __init__(self, cyber: bool = False):
         cmd.Cmd.__init__(self)
@@ -121,6 +122,28 @@ class ExtendedCmd(cmd.Cmd):
 
         return object.__getattribute__(self, attr)
 
+    def _load_targetrc(self, path: pathlib.Path) -> None:
+        """Load and execute commands from the run commands file."""
+        try:
+            with path.open() as fh:
+                for line in fh:
+                    if (line := line.strip()) and not line.startswith("#"):  # Ignore empty lines and comments
+                        self.onecmd(line)
+        except FileNotFoundError:
+            # The .targetrc file is optional
+            pass
+        except Exception as e:
+            log.debug("Error processing .targetrc file: %s", e)
+
+    def _get_targetrc_path(self) -> pathlib.Path | None:
+        """Get the path to the run commands file. Can return ``None`` if ``DEFAULT_RUNCOMMANDS_FILE`` is not set."""
+        return pathlib.Path(self.DEFAULT_RUNCOMMANDS_FILE).expanduser() if self.DEFAULT_RUNCOMMANDS_FILE else None
+
+    def preloop(self) -> None:
+        super().preloop()
+        if targetrc_path := self._get_targetrc_path():
+            self._load_targetrc(targetrc_path)
+
     @staticmethod
     def check_compatible(target: Target) -> bool:
         return True
@@ -309,6 +332,8 @@ class TargetCmd(ExtendedCmd):
     DEFAULT_HISTFILESIZE = 10_000
     DEFAULT_HISTDIR = None
     DEFAULT_HISTDIRFMT = ".dissect_history_{uid}_{target}"
+    DEFAULT_RUNCOMMANDS_FILE = "~/.targetrc"
+    CONFIG_KEY_RUNCOMMANDS_FILE = "TARGETRCFILE"
 
     def __init__(self, target: Target):
         self.target = target
@@ -338,7 +363,15 @@ class TargetCmd(ExtendedCmd):
 
         super().__init__(self.target.props.get("cyber"))
 
+    def _get_targetrc_path(self) -> pathlib.Path:
+        """Get the path to the run commands file."""
+
+        return pathlib.Path(
+            getattr(self.target._config, self.CONFIG_KEY_RUNCOMMANDS_FILE, self.DEFAULT_RUNCOMMANDS_FILE)
+        ).expanduser()
+
     def preloop(self) -> None:
+        super().preloop()
         if readline and self.histfile.exists():
             try:
                 readline.read_history_file(self.histfile)
@@ -507,7 +540,6 @@ class TargetCli(TargetCmd):
         self.prompt_base = _target_name(target)
 
         TargetCmd.__init__(self, target)
-
         self._clicache = {}
         self.cwd = None
         self.chdir("/")
@@ -1144,6 +1176,10 @@ class UnixConfigTreeCli(TargetCli):
 class RegistryCli(TargetCmd):
     """CLI for browsing the registry."""
 
+    # Registry shell is incompatible with default shell, so override the default rc file and config key
+    DEFAULT_RUNCOMMANDS_FILE = "~/.targetrc.registry"
+    CONFIG_KEY_RUNCOMMANDS_FILE = "TARGETRCFILE_REGISTRY"
+
     def __init__(self, target: Target, registry: regutil.RegfHive | None = None):
         self.prompt_base = _target_name(target)
 

{dissect_target-3.20.dev17 → dissect_target-3.20.dev19/dissect.target.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.20.dev17
+Version: 3.20.dev19
 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.20.dev17 → dissect_target-3.20.dev19}/dissect.target.egg-info/SOURCES.txt

@@ -153,6 +153,8 @@ dissect/target/plugins/apps/ssh/ssh.py
 dissect/target/plugins/apps/texteditor/__init__.py
 dissect/target/plugins/apps/texteditor/texteditor.py
 dissect/target/plugins/apps/texteditor/windowsnotepad.py
+dissect/target/plugins/apps/virtualization/__init__.py
+dissect/target/plugins/apps/virtualization/vmware_workstation.py
 dissect/target/plugins/apps/vpn/__init__.py
 dissect/target/plugins/apps/vpn/openvpn.py
 dissect/target/plugins/apps/vpn/wireguard.py
@@ -477,6 +479,8 @@ tests/plugins/apps/ssh/test_opensshd.py
 tests/plugins/apps/ssh/test_putty.py
 tests/plugins/apps/texteditor/__init__.py
 tests/plugins/apps/texteditor/test_texteditor.py
+tests/plugins/apps/virtualization/__init__.py
+tests/plugins/apps/virtualization/test_vmware_workstation.py
 tests/plugins/apps/vpn/__init__.py
 tests/plugins/apps/vpn/test_openvpn.py
 tests/plugins/apps/vpn/test_wireguard.py
@@ -495,6 +499,7 @@ tests/plugins/child/test_hyperv.py
 tests/plugins/child/test_parallels.py
 tests/plugins/child/test_qemu.py
 tests/plugins/child/test_virtuozzo.py
+tests/plugins/child/test_vmware_workstation.py
 tests/plugins/child/test_wsl.py
 tests/plugins/filesystem/__init__.py
 tests/plugins/filesystem/test_acquire_handles.py

dissect_target-3.20.dev19/tests/plugins/apps/virtualization/test_vmware_workstation.py

@@ -0,0 +1,38 @@
+from datetime import datetime, timezone
+
+import pytest
+
+from dissect.target.filesystem import VirtualFilesystem
+from dissect.target.plugins.apps.virtualization.vmware_workstation import (
+    VmwareWorkstationPlugin,
+)
+from dissect.target.target import Target
+from tests._utils import absolute_path
+
+
+@pytest.mark.parametrize(
+    "target,fs,dnd_path",
+    [
+        ("target_win_users", "fs_win", "Users\\John\\AppData\\Local\\Temp\\VmwareDND"),
+        ("target_unix_users", "fs_unix", "/home/user/.cache/vmware/drag_and_drop"),
+    ],
+)
+def test_vmware_workstation_clipboard_dnd(
+    target: Target, fs: VirtualFilesystem, dnd_path: str, request: pytest.FixtureRequest
+) -> None:
+    """test if we correctly detect drag and drop artifacts on Windows and Unix targets"""
+
+    target = request.getfixturevalue(target)
+    fs = request.getfixturevalue(fs)
+    fs.map_dir_from_tar(dnd_path, absolute_path("_data/plugins/apps/virtualization/vmware_workstation/dnd.tar"))
+    target.add_plugin(VmwareWorkstationPlugin)
+    results = sorted(list(target.vmware.clipboard()), key=lambda r: r.path)
+    dnd_path = dnd_path.replace("\\", "/")
+
+    assert len(results) == 3
+    assert [str(r.path).replace("C:\\", "").replace("\\", "/") for r in results] == [
+        f"{dnd_path}/8lkBf1/wachter.jpg",
+        f"{dnd_path}/iUpQHG/credentials.txt",
+        f"{dnd_path}/x1G9fJ/example.txt",
+    ]
+    assert results[0].ts == datetime(2024, 9, 18, 11, 16, 44, tzinfo=timezone.utc)

dissect_target-3.20.dev19/tests/plugins/child/test_vmware_workstation.py

@@ -0,0 +1,35 @@
+import pytest
+
+from dissect.target.filesystem import VirtualFilesystem
+from dissect.target.plugins.child.vmware_workstation import (
+    VmwareWorkstationChildTargetPlugin,
+)
+from dissect.target.target import Target
+from tests._utils import absolute_path
+
+
+@pytest.mark.parametrize(
+    "target,fs,inventory_path",
+    [
+        ("target_win_users", "fs_win", "Users\\John\\AppData\\Roaming\\VMware\\inventory.vmls"),
+        ("target_unix_users", "fs_unix", "/home/user/.vmware/inventory.vmls"),
+    ],
+)
+def test_child_vmware_workstation(
+    target: Target, fs: VirtualFilesystem, inventory_path: str, request: pytest.FixtureRequest
+) -> None:
+    """test if we detect VMware Workstation children from inventory files correctly on Windows and Unix targets"""
+
+    target = request.getfixturevalue(target)
+    fs = request.getfixturevalue(fs)
+
+    fs.map_file(inventory_path, absolute_path("_data/plugins/child/vmware_workstation/inventory.vmls"))
+    target.add_plugin(VmwareWorkstationChildTargetPlugin)
+    children = list(target.list_children())
+
+    assert len(children) == 3
+    assert [c.path for c in children] == [
+        "/path/to/first/vm/vm.vmx",
+        "/path/to/second/vm/vm.vmx",
+        "/path/to/third/vm/vm.vmx",
+    ]

{dissect_target-3.20.dev17 → dissect_target-3.20.dev19}/tests/tools/test_shell.py

@@ -1,10 +1,11 @@
 import argparse
+import pathlib
 import platform
 import sys
 from io import BytesIO, StringIO
 from pathlib import Path
-from typing import Callable
-from unittest.mock import MagicMock
+from typing import Callable, Iterator
+from unittest.mock import MagicMock, call, mock_open, patch
 
 import pytest
 
@@ -130,6 +131,35 @@ def test_targetcli_autocomplete(target_bare: Target, monkeypatch: pytest.MonkeyP
     assert suggestions == [f"{subfolder_name}/", subfile_name]
 
 
+@pytest.fixture
+def targetrc_file() -> Iterator[list[str]]:
+    content = """
+    ls
+        # This is a comment line and should be ignored
+    ll
+    """
+
+    original_open = pathlib.Path.open
+
+    def custom_open(self: Path, *args, **kwargs):
+        if self.name.endswith(".targetrc"):
+            return mock_open(read_data=content)()
+        return original_open(self, *args, **kwargs)
+
+    with patch("pathlib.Path.open", custom_open):
+        yield ["ls", "ll"]
+
+
+def test_targetcli_targetrc(target_bare: Target, targetrc_file: list[str]) -> None:
+    with patch.object(TargetCli, "onecmd", autospec=True) as mock_onecmd:
+        cli = TargetCli(target_bare)
+
+        cli.preloop()
+
+        expected_calls = [call(cli, cmd) for cmd in targetrc_file]
+        mock_onecmd.assert_has_calls(expected_calls, any_order=False)
+
+
 @pytest.mark.skipif(platform.system() == "Windows", reason="Unix-specific test.")
 def test_pipe_symbol_parsing(capfd: pytest.CaptureFixture, target_bare: Target) -> None:
     cli = TargetCli(target_bare)