dissect.target 3.20.2.dev60__tar.gz → 3.20.2.dev62__tar.gz

{dissect_target-3.20.2.dev60/dissect.target.egg-info → dissect_target-3.20.2.dev62}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.target
-Version: 3.20.2.dev60
+Version: 3.20.2.dev62
 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
@@ -86,6 +86,7 @@ Requires-Dist: dissect.util<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.vmfs[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.volume[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.xfs[dev]<4.0.dev,>=3.0.dev; extra == "dev"
+Requires-Dist: pexpect; extra == "dev"
 Provides-Extra: yara
 Requires-Dist: dissect.target[full]; extra == "yara"
 Requires-Dist: yara-python; extra == "yara"

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/dissect/target/plugins/apps/container/docker.py

@@ -32,7 +32,8 @@ DockerContainerRecord = TargetRecordDescriptor(
         ("datetime", "finished"),
         ("string", "ports"),
         ("string", "names"),
-        ("stringlist", "volumes"),
+        ("string[]", "volumes"),
+        ("string[]", "environment"),
         ("path", "mount_path"),
         ("path", "config_path"),
     ],
@@ -215,6 +216,7 @@ class DockerPlugin(Plugin):
                     ports=convert_ports(ports),
                     names=config.get("Name", "").replace("/", "", 1),
                     volumes=volumes,
+                    environment=config.get("Config", {}).get("Env", []),
                     mount_path=mount_path,
                     config_path=config_path,
                     _target=self.target,

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/dissect/target/tools/shell.py

@@ -33,6 +33,7 @@ from dissect.target.exceptions import (
 )
 from dissect.target.filesystem import FilesystemEntry
 from dissect.target.helpers import cyber, fsutil, regutil
+from dissect.target.helpers.utils import StrEnum
 from dissect.target.plugin import FunctionDescriptor, alias, arg, clone_alias
 from dissect.target.target import Target
 from dissect.target.tools.fsutils import (
@@ -76,6 +77,56 @@ except ImportError:
     readline = None
 
 
+def readline_escape(s: str | dict[str, str]) -> str | dict[str, str]:
+    """Escape a string or values in dictionary for readline prompt.
+
+    Used to embed terminal-specific escape sequences in prompts.
+
+    References:
+        - https://wiki.hackzine.org/development/misc/readline-color-prompt.html
+        - http://stackoverflow.com/a/9468954/148845
+        - RL_PROMPT_START_IGNORE = "\001"
+        - RL_PROMPT_END_IGNORE = "\002"
+    """
+    if isinstance(s, dict):
+        return {k: f"\001{v}\002" for k, v in s.items()}
+    return f"\001{s}\002"
+
+
+class AnsiColors(StrEnum):
+    """ANSI color escape sequences."""
+
+    # Base formatting
+    RESET = "\033[0m"
+
+    # Basic colors
+    RED = "\033[31m"
+    GREEN = "\033[32m"
+    YELLOW = "\033[33m"
+    BLUE = "\033[34m"
+    MAGENTA = "\033[35m"
+    CYAN = "\033[36m"
+    WHITE = "\033[37m"
+
+    # Bold colors
+    BOLD_RED = "\033[1;31m"
+    BOLD_GREEN = "\033[1;32m"
+    BOLD_YELLOW = "\033[1;33m"
+    BOLD_BLUE = "\033[1;34m"
+    BOLD_MAGENTA = "\033[1;35m"
+    BOLD_CYAN = "\033[1;36m"
+    BOLD_WHITE = "\033[1;37m"
+
+    @classmethod
+    def as_dict(cls) -> dict[str, str]:
+        """Return ANSI color escape sequences as a dictionary."""
+        return {item.name: item.value for item in cls}
+
+
+# ANSI color escape sequences for readline prompt
+ANSI_COLORS = readline_escape(AnsiColors.as_dict())
+
+
 class ExtendedCmd(cmd.Cmd):
     """Subclassed cmd.Cmd to provide some additional features.
 
@@ -360,7 +411,7 @@ class TargetCmd(ExtendedCmd):
             self.prompt_ps1 = "{base}:{cwd}$ "
 
         else:
-            self.prompt_ps1 = "\x1b[1;32m{base}\x1b[0m:\x1b[1;34m{cwd}\x1b[0m$ "
+            self.prompt_ps1 = "{BOLD_GREEN}{base}{RESET}:{BOLD_BLUE}{cwd}{RESET}$ "
 
         super().__init__(self.target.props.get("cyber"))
 
@@ -547,7 +598,7 @@ class TargetCli(TargetCmd):
 
     @property
     def prompt(self) -> str:
-        return self.prompt_ps1.format(base=self.prompt_base, cwd=self.cwd)
+        return self.prompt_ps1.format(base=self.prompt_base, cwd=self.cwd, **ANSI_COLORS)
 
     def completedefault(self, text: str, line: str, begidx: int, endidx: int) -> list[str]:
         path = self.resolve_path(line[:begidx].rsplit(" ")[-1])
@@ -1199,7 +1250,7 @@ class RegistryCli(TargetCmd):
 
     @property
     def prompt(self) -> str:
-        return "(registry) " + self.prompt_ps1.format(base=self.prompt_base, cwd=self.cwd)
+        return "(registry) " + self.prompt_ps1.format(base=self.prompt_base, cwd=self.cwd, **ANSI_COLORS)
 
     def completedefault(self, text: str, line: str, begidx: int, endidx: int) -> list[str]:
         path = line[:begidx].rsplit(" ")[-1]

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62/dissect.target.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.target
-Version: 3.20.2.dev60
+Version: 3.20.2.dev62
 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
@@ -86,6 +86,7 @@ Requires-Dist: dissect.util<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.vmfs[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.volume[dev]<4.0.dev,>=3.0.dev; extra == "dev"
 Requires-Dist: dissect.xfs[dev]<4.0.dev,>=3.0.dev; extra == "dev"
+Requires-Dist: pexpect; extra == "dev"
 Provides-Extra: yara
 Requires-Dist: dissect.target[full]; extra == "yara"
 Requires-Dist: yara-python; extra == "yara"

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/dissect.target.egg-info/requires.txt

@@ -40,6 +40,7 @@ dissect.util<4.0.dev,>=3.0.dev
 dissect.vmfs[dev]<4.0.dev,>=3.0.dev
 dissect.volume[dev]<4.0.dev,>=3.0.dev
 dissect.xfs[dev]<4.0.dev,>=3.0.dev
+pexpect
 
 [dev:platform_system != "Windows" or platform_python_implementation != "PyPy"]
 dissect.fve[dev]<5.0.dev,>=4.0.dev

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/pyproject.toml

@@ -106,6 +106,7 @@ dev = [
     "dissect.vmfs[dev]>=3.0.dev,<4.0.dev",
     "dissect.volume[dev]>=3.0.dev,<4.0.dev",
     "dissect.xfs[dev]>=3.0.dev,<4.0.dev",
+    "pexpect",
 ]
 yara = [
     # Grab the dependencies for dissect.target

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/tests/plugins/apps/container/test_docker.py

@@ -164,6 +164,10 @@ def test_regression_running_container_parsing(target_unix: Target, fs_unix: Virt
                 "1337/udp": {},
             },
             "Image": "docker.io/debian",
+            "Env": [
+                "FOO=bar",
+                "HELLO=world",
+            ],
         },
         "NetworkSettings": {
             "Ports": {},
@@ -198,5 +202,6 @@ def test_regression_running_container_parsing(target_unix: Target, fs_unix: Virt
     assert results[0].ports == str({"1337/tcp": "0.0.0.0:1337", "1337/udp": "0.0.0.0:1337"})
     assert results[0].names == "foo"
     assert results[0].volumes == ["/somewhere/on/host/file.txt:/dest/file.txt"]
+    assert results[0].environment == ["FOO=bar", "HELLO=world"]
     assert results[0].mount_path == "/var/lib/docker/image/overlay2/layerdb/mounts/deadbeef"
     assert results[0].config_path == "/var/lib/docker/containers/deadbeef/config.v2.json"

{dissect_target-3.20.2.dev60 → dissect_target-3.20.2.dev62}/tests/tools/test_shell.py

@@ -1,9 +1,12 @@
 from __future__ import annotations
 
 import argparse
+import os
 import pathlib
 import platform
+import re
 import sys
+from collections import ChainMap
 from io import BytesIO, StringIO
 from pathlib import Path
 from typing import Callable, Iterator
@@ -23,6 +26,13 @@ from dissect.target.tools.shell import (
 from dissect.target.tools.shell import main as target_shell
 from tests._utils import absolute_path
 
+try:
+    import pexpect
+
+    HAS_PEXPECT = True
+except ImportError:
+    HAS_PEXPECT = False
+
 GREP_MATCH = "test1 and test2"
 GREP_MISSING = "test2 alone"
 INPUT_STREAM = f"""
@@ -374,3 +384,54 @@ def test_shell_hostname_escaping(
 
     assert not err
     assert "hostname\\x00\\x01\\x02\\x03" in out
+
+
+@pytest.mark.skipif(not HAS_PEXPECT, reason="requires pexpect")
+@pytest.mark.skipif(
+    platform.python_implementation() == "PyPy",
+    reason="PyPy's prompt contains too much ANSI escape codes",
+)
+@pytest.mark.skipif(
+    platform.system() == "Windows",
+    reason="pexpect.spawn not available on Windows",
+)
+def test_shell_prompt_tab_autocomplete() -> None:
+    """Test the prompt tab-autocompletion."""
+    target_path = absolute_path("_data/tools/info/image.tar")
+
+    # We set NO_COLOR=1 so that the output is not colored and easier to match
+    child = pexpect.spawn("target-shell", args=[target_path], env=ChainMap(os.environ, {"NO_COLOR": "1"}))
+
+    # increase window size to avoid line wrapping
+    child.setwinsize(100, 100)
+
+    # note that the expect pattern will be re.compiled so we need to escape regex special characters
+    child.expect(re.escape("ubuntu:/$ "), timeout=20)
+    # this should auto complete to `ls /home/user`
+    child.sendline("ls /home/u\t")
+    # expect the prompt to be printed again
+    child.expect(re.escape("ls /home/user/\r\n"), timeout=5)
+    # execute the autocompleted command
+    child.send("\n")
+    # we expect the files in /home/user to be printed
+    child.expect(re.escape(".bash_history\r\n.zsh_history\r\n"), timeout=5)
+    child.expect(re.escape("ubuntu:/$ "), timeout=5)
+
+    # send partial ls /etc/ command
+    child.send("ls /etc/")
+
+    # we send two TABS to get the list of files in /etc/
+    child.send("\t\t")
+
+    # expect the files in /etc/ to be printed
+    child.expect("hosts       localtime   network/    os-release  passwd      shadow      timezone\r\n", timeout=5)
+
+    # send newline to just list everything in /etc/
+    child.send("\n")
+    # expect the last few files in /etc/ to be printed
+    child.expect("shadow\r\ntimezone\r\n", timeout=5)
+
+    # exit the shell
+    child.expect(re.escape("ubuntu:/$ "), timeout=5)
+    child.sendline("exit")
+    child.expect(pexpect.EOF, timeout=5)