dissect.target 3.19.dev57__py3-none-any.whl → 3.20__py3-none-any.whl

dissect/target/tools/shell.py

@@ -95,6 +95,8 @@ class ExtendedCmd(cmd.Cmd):
     """
 
     CMD_PREFIX = "cmd_"
+    _runtime_aliases = {}
+    DEFAULT_RUNCOMMANDS_FILE = None
 
     def __init__(self, cyber: bool = False):
         cmd.Cmd.__init__(self)
@@ -120,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
@@ -164,6 +188,11 @@ class ExtendedCmd(cmd.Cmd):
         return None
 
     def default(self, line: str) -> bool:
+        com, arg, _ = self.parseline(line)
+        if com in self._runtime_aliases:
+            expanded = " ".join([self._runtime_aliases[com], arg])
+            return self.onecmd(expanded)
+
         if (should_exit := self._handle_command(line)) is not None:
             return should_exit
 
@@ -176,7 +205,8 @@ class ExtendedCmd(cmd.Cmd):
 
         When entering an empty command, the cmd module will by default repeat the previous command.
         By defining an empty ``emptyline`` function we make sure no command is executed instead.
-        Resources:
+
+        References:
             - https://stackoverflow.com/a/16479030
             - https://github.com/python/cpython/blob/3.12/Lib/cmd.py#L10
         """
@@ -230,6 +260,43 @@ class ExtendedCmd(cmd.Cmd):
     def complete_man(self, *args) -> list[str]:
         return cmd.Cmd.complete_help(self, *args)
 
+    def do_unalias(self, line: str) -> bool:
+        """delete runtime alias"""
+        aliases = list(shlex.shlex(line, posix=True))
+        for aliased in aliases:
+            if aliased in self._runtime_aliases:
+                del self._runtime_aliases[aliased]
+            else:
+                print(f"alias {aliased} not found")
+        return False
+
+    def do_alias(self, line: str) -> bool:
+        """create a runtime alias"""
+        args = list(shlex.shlex(line, posix=True))
+
+        if not args:
+            for aliased, command in self._runtime_aliases.items():
+                print(f"alias {aliased}={command}")
+            return False
+
+        while args:
+            alias_name = args.pop(0)
+            try:
+                equals = args.pop(0)
+                # our parser works different, so we have to stop this
+                if equals != "=":
+                    raise RuntimeError("Token not allowed")
+                expanded = args.pop(0) if args else ""  # this is how it works in bash
+                self._runtime_aliases[alias_name] = expanded
+            except IndexError:
+                if alias_name in self._runtime_aliases:
+                    print(f"alias {alias_name}={self._runtime_aliases[alias_name]}")
+                else:
+                    print(f"alias {alias_name} not found")
+                pass
+
+        return False
+
     def do_clear(self, line: str) -> bool:
         """clear the terminal screen"""
         os.system("cls||clear")
@@ -266,6 +333,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
@@ -295,7 +364,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)
@@ -464,7 +541,6 @@ class TargetCli(TargetCmd):
         self.prompt_base = _target_name(target)
 
         TargetCmd.__init__(self, target)
-
         self._clicache = {}
         self.cwd = None
         self.chdir("/")
@@ -1101,6 +1177,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)
 
@@ -1331,29 +1411,38 @@ def build_pipe_stdout(pipe_parts: list[str]) -> Iterator[TextIO]:
         yield pipe_stdin
 
 
-def open_shell(targets: list[str | pathlib.Path], python: bool, registry: bool) -> None:
+def open_shell(targets: list[str | pathlib.Path], python: bool, registry: bool, commands: list[str] | None) -> None:
     """Helper method for starting a regular, Python or registry shell for one or multiple targets."""
     targets = list(Target.open_all(targets))
 
     if python:
-        python_shell(targets)
+        python_shell(targets, commands=commands)
     else:
         cli_cls = RegistryCli if registry else TargetCli
-        target_shell(targets, cli_cls=cli_cls)
+        target_shell(targets, cli_cls=cli_cls, commands=commands)
 
 
-def target_shell(targets: list[Target], cli_cls: type[TargetCmd]) -> None:
+def target_shell(targets: list[Target], cli_cls: type[TargetCmd], commands: list[str] | None) -> None:
     """Helper method for starting a :class:`TargetCli` or :class:`TargetHubCli` for one or multiple targets."""
     if cli := create_cli(targets, cli_cls):
+        if commands is not None:
+            for command in commands:
+                cli.onecmd(command)
+            return
         run_cli(cli)
 
 
-def python_shell(targets: list[Target]) -> None:
+def python_shell(targets: list[Target], commands: list[str] | None = None) -> None:
     """Helper method for starting a (I)Python shell with multiple targets."""
     banner = "Loaded targets in 'targets' variable. First target is in 't'."
     ns = {"targets": targets, "t": targets[0]}
 
     try:
+        if commands is not None:
+            for command in commands:
+                eval(command, ns)
+            return
+
         import IPython
 
         IPython.embed(header=banner, user_ns=ns, colors="linux")
@@ -1433,7 +1522,7 @@ def main() -> None:
         default=None,
         help="select a specific loader (i.e. vmx, raw)",
     )
-
+    parser.add_argument("-c", "--commands", action="store", nargs="*", help="commands to execute")
     configure_generic_arguments(parser)
     args, rest = parser.parse_known_args()
     args.targets = args_to_uri(args.targets, args.loader, rest) if args.loader else args.targets
@@ -1458,7 +1547,7 @@ def main() -> None:
             )
 
     try:
-        open_shell(args.targets, args.python, args.registry)
+        open_shell(args.targets, args.python, args.registry, args.commands)
     except TargetError as e:
         log.error(e)
         log.debug("", exc_info=e)

dissect/target/tools/utils.py

@@ -16,7 +16,6 @@ from dissect.target import Target
 from dissect.target.exceptions import UnsupportedPluginError
 from dissect.target.helpers import docs, keychain
 from dissect.target.helpers.docs import get_docstring
-from dissect.target.helpers.targetd import CommandProxy
 from dissect.target.loader import LOADERS_BY_SCHEME
 from dissect.target.plugin import (
     OSPlugin,
@@ -91,6 +90,10 @@ def generate_argparse_for_unbound_method(
         raise ValueError(f"Value `{method}` is not an unbound plugin method")
 
     desc = method.__doc__ or docs.get_func_description(method, with_docstrings=True)
+
+    if "\n" in desc:
+        desc = inspect.cleandoc(desc)
+
     help_formatter = argparse.RawDescriptionHelpFormatter
     parser = argparse.ArgumentParser(description=desc, formatter_class=help_formatter, conflict_handler="resolve")
 
@@ -227,15 +230,15 @@ def get_target_attribute(target: Target, func: PluginFunction) -> Union[Plugin,
             target.add_plugin(plugin_class)
         except UnsupportedPluginError as e:
             raise UnsupportedPluginError(
-                f"Unsupported function `{func.method_name}` for target with plugin {func.class_object}", cause=e
-            )
+                f"Unsupported function `{func.method_name}` for target with plugin {func.class_object}"
+            ) from e
 
     _, target_attr = plugin_factory(target, plugin_class, func.method_name, func.plugin_desc["namespace"])
     return target_attr
 
 
 def plugin_function_with_argparser(
-    target_attr: Union[Plugin, Callable]
+    target_attr: Union[Plugin, Callable],
 ) -> tuple[Optional[Iterator], Optional[argparse.ArgumentParser]]:
     """Resolves which plugin function to execute, and creates the argument parser for said plugin."""
     plugin_method = None
@@ -250,9 +253,6 @@ def plugin_function_with_argparser(
 
         plugin_method = plugin_obj.get_all_records
         parser = generate_argparse_for_plugin(plugin_obj)
-    elif isinstance(target_attr, CommandProxy):
-        plugin_method = target_attr.command()
-        parser = generate_argparse_for_bound_method(plugin_method)
     elif callable(target_attr):
         plugin_method = target_attr
         parser = generate_argparse_for_bound_method(target_attr)

dissect/target/volume.py

@@ -334,7 +334,7 @@ def open(fh: BinaryIO, *args, **kwargs) -> DissectVolumeSystem:
     try:
         return disk.DissectVolumeSystem(fh)
     except Exception as e:
-        raise VolumeSystemError(f"Failed to load volume system for {fh}", cause=e)
+        raise VolumeSystemError(f"Failed to load volume system for {fh}") from e
     finally:
         fh.seek(offset)
 
@@ -353,7 +353,7 @@ def is_lvm_volume(volume: BinaryIO) -> bool:
             log.info("Failed to import %s", logical_vs)
             log.debug("", exc_info=e)
         except Exception as e:
-            raise VolumeSystemError(f"Failed to detect logical volume for {volume}", cause=e)
+            raise VolumeSystemError(f"Failed to detect logical volume for {volume}") from e
 
     return False
 
@@ -372,7 +372,7 @@ def is_encrypted(volume: BinaryIO) -> bool:
             log.info("Failed to import %s", manager)
             log.debug("", exc_info=e)
         except Exception as e:
-            raise VolumeSystemError(f"Failed to detect encrypted volume for {volume}", cause=e)
+            raise VolumeSystemError(f"Failed to detect encrypted volume for {volume}") from e
     return False
 
 
@@ -422,4 +422,4 @@ def open_lvm(volumes: list[BinaryIO], *args, **kwargs) -> Iterator[VolumeSystem]
             log.info("Failed to import %s", logical_vs)
             log.debug("", exc_info=e)
         except Exception as e:
-            raise VolumeSystemError(f"Failed to load logical volume system for {volumes}", cause=e)
+            raise VolumeSystemError(f"Failed to load logical volume system for {volumes}") from e

{dissect.target-3.19.dev57.dist-info → dissect.target-3.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.19.dev57
+Version: 3.20
 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
@@ -31,13 +31,14 @@ Requires-Dist: dissect.ntfs <4,>=3.4
 Requires-Dist: dissect.regf <4,>=3.3
 Requires-Dist: dissect.util <4,>=3
 Requires-Dist: dissect.volume <4,>=2
-Requires-Dist: flow.record ~=3.15.0
+Requires-Dist: flow.record ~=3.18.0
 Requires-Dist: structlog
 Provides-Extra: cb
 Requires-Dist: dissect.target[full] ; extra == 'cb'
 Requires-Dist: carbon-black-cloud-sdk ~=1.4.3 ; extra == 'cb'
 Provides-Extra: dev
 Requires-Dist: dissect.target[full,mqtt,yara] ; extra == 'dev'
+Requires-Dist: dissect.archive[dev] <2.0.dev,>=1.0.dev ; extra == 'dev'
 Requires-Dist: dissect.btrfs[dev] <2.0.dev,>=1.0.dev ; extra == 'dev'
 Requires-Dist: dissect.cim[dev] <4.0.dev,>=3.0.dev ; extra == 'dev'
 Requires-Dist: dissect.clfs[dev] <2.0.dev,>=1.0.dev ; extra == 'dev'
@@ -61,8 +62,10 @@ 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: dissect.fve[dev] <5.0.dev,>=4.0.dev ; (platform_system != "Windows" or platform_python_implementation != "PyPy") and extra == 'dev'
 Provides-Extra: full
 Requires-Dist: asn1crypto ; extra == 'full'
+Requires-Dist: dissect.archive <2,>=1 ; extra == 'full'
 Requires-Dist: dissect.btrfs <2,>=1 ; extra == 'full'
 Requires-Dist: dissect.cim <4,>=3 ; extra == 'full'
 Requires-Dist: dissect.clfs <2,>=1 ; extra == 'full'
@@ -84,6 +87,7 @@ Requires-Dist: fusepy ; extra == 'full'
 Requires-Dist: pycryptodome ; extra == 'full'
 Requires-Dist: ruamel.yaml ; extra == 'full'
 Requires-Dist: zstandard ; extra == 'full'
+Requires-Dist: dissect.fve <5,>=4 ; (platform_system != "Windows" or platform_python_implementation != "PyPy") and extra == 'full'
 Requires-Dist: tomli ; (python_version < "3.11") and extra == 'full'
 Provides-Extra: mqtt
 Requires-Dist: dissect.target[full] ; extra == 'mqtt'