dissect.target 3.18.dev15__py3-none-any.whl → 3.19__py3-none-any.whl

dissect/target/target.py

@@ -87,9 +87,10 @@ class Target:
         self._applied = False
 
         try:
-            self._config = config.load(self.path)
+            self._config = config.load([self.path, Path.cwd(), Path.home()])
         except Exception as e:
-            self.log.debug("Error loading config file", exc_info=e)
+            self.log.warning("Error loading config file: %s", self.path)
+            self.log.debug("", exc_info=e)
             self._config = config.load(None)  # This loads an empty config.
 
         # Fill the disks and/or volumes and/or filesystems and apply() will
@@ -344,7 +345,7 @@ class Target:
                 child_plugin.check_compatible()
                 self._child_plugins[child_plugin.__type__] = child_plugin
             except PluginError as e:
-                self.log.info("Child plugin reported itself as incompatible: %s (%s)", plugin_desc["class"], e)
+                self.log.debug("Child plugin reported itself as incompatible: %s (%s)", plugin_desc["class"], e)
             except Exception:
                 self.log.exception(
                     "An exception occurred while checking for child plugin compatibility: %s", plugin_desc["class"]

dissect/target/tools/fs.py

@@ -3,7 +3,6 @@
 
 import argparse
 import logging
-import operator
 import os
 import pathlib
 import shutil
@@ -12,6 +11,7 @@ import sys
 from dissect.target import Target
 from dissect.target.exceptions import TargetError
 from dissect.target.helpers.fsutil import TargetPath
+from dissect.target.tools.fsutils import print_ls, print_stat
 from dissect.target.tools.utils import (
     catch_sigpipe,
     configure_generic_arguments,
@@ -23,24 +23,42 @@ logging.lastResort = None
 logging.raiseExceptions = False
 
 
-def ls(t, path, args):
-    for e in sorted(path.iterdir(), key=operator.attrgetter("name")):
-        print(e.name)
+def ls(t: Target, path: TargetPath, args: argparse.Namespace) -> None:
+    if args.use_ctime and args.use_atime:
+        log.error("Can't specify -c and -u at the same time")
+        return
+    if not path or not path.exists():
+        return
+
+    # Only output with colors if stdout is a tty
+    use_colors = sys.stdout.buffer.isatty()
+
+    print_ls(
+        path,
+        0,
+        sys.stdout,
+        args.l,
+        args.human_readable,
+        args.recursive,
+        args.use_ctime,
+        args.use_atime,
+        use_colors,
+    )
 
 
-def cat(t, path, args):
+def cat(t: Target, path: TargetPath, args: argparse.Namespace) -> None:
     stdout = sys.stdout
     if hasattr(stdout, "buffer"):
         stdout = stdout.buffer
     shutil.copyfileobj(path.open(), stdout)
 
 
-def walk(t, path, args):
+def walk(t: Target, path: TargetPath, args: argparse.Namespace) -> None:
     for e in path.rglob("*"):
         print(str(e))
 
 
-def cp(t, path, args):
+def cp(t: Target, path: TargetPath, args: argparse.Namespace) -> None:
     output = os.path.abspath(os.path.expanduser(args.output))
     if path.is_file():
         _extract_path(path, os.path.join(output, path.name))
@@ -52,6 +70,12 @@ def cp(t, path, args):
         print("[!] Failed, unsuported file type: %s" % path)
 
 
+def stat(t: Target, path: TargetPath, args: argparse.Namespace) -> None:
+    if not path or not path.exists():
+        return
+    print_stat(path, sys.stdout, args.dereference)
+
+
 def _extract_path(path: TargetPath, output_path: str) -> None:
     print("%s -> %s" % (path, output_path))
 
@@ -75,7 +99,7 @@ def _extract_path(path: TargetPath, output_path: str) -> None:
 
 
 @catch_sigpipe
-def main():
+def main() -> None:
     help_formatter = argparse.ArgumentDefaultsHelpFormatter
     parser = argparse.ArgumentParser(
         description="dissect.target",
@@ -85,24 +109,38 @@ def main():
     parser.add_argument("target", type=pathlib.Path, help="Target to load", metavar="TARGET")
 
     baseparser = argparse.ArgumentParser(add_help=False)
-    baseparser.add_argument("path", type=str, help="Path to perform an action on", metavar="PATH")
+    baseparser.add_argument("path", type=str, help="path to perform an action on", metavar="PATH")
 
-    subparsers = parser.add_subparsers(dest="subcommand", help="Subcommands for performing various actions")
-    parser_ls = subparsers.add_parser("ls", help="Show a directory listing", parents=[baseparser])
+    subparsers = parser.add_subparsers(dest="subcommand", help="subcommands for performing various actions")
+    parser_ls = subparsers.add_parser(
+        "ls", help="Show a directory listing", parents=[baseparser], conflict_handler="resolve"
+    )
+    parser_ls.add_argument("-l", action="store_true")
+    parser_ls.add_argument("-a", "--all", action="store_true")  # ignored but included for proper argument parsing
+    parser_ls.add_argument("-h", "--human-readable", action="store_true")
+    parser_ls.add_argument("-R", "--recursive", action="store_true", help="recursively list subdirectories encountered")
+    parser_ls.add_argument(
+        "-c", action="store_true", dest="use_ctime", help="show time when file status was last changed"
+    )
+    parser_ls.add_argument("-u", action="store_true", dest="use_atime", help="show time of last access")
     parser_ls.set_defaults(handler=ls)
 
-    parser_cat = subparsers.add_parser("cat", help="Dump file contents", parents=[baseparser])
+    parser_cat = subparsers.add_parser("cat", help="dump file contents", parents=[baseparser])
     parser_cat.set_defaults(handler=cat)
 
-    parser_find = subparsers.add_parser("walk", help="Perform a walk", parents=[baseparser])
+    parser_stat = subparsers.add_parser("stat", help="display file status", parents=[baseparser])
+    parser_stat.add_argument("-L", "--dereference", action="store_true")
+    parser_stat.set_defaults(handler=stat)
+
+    parser_find = subparsers.add_parser("walk", help="perform a walk", parents=[baseparser])
     parser_find.set_defaults(handler=walk)
 
     parser_cp = subparsers.add_parser(
         "cp",
-        help="Copy multiple files to a directory specified by --output",
+        help="copy multiple files to a directory specified by --output",
         parents=[baseparser],
     )
-    parser_cp.add_argument("-o", "--output", type=str, default=".", help="Output directory")
+    parser_cp.add_argument("-o", "--output", type=str, default=".", help="output directory")
     parser_cp.set_defaults(handler=cp)
 
     configure_generic_arguments(parser)

dissect/target/tools/fsutils.py

@@ -0,0 +1,243 @@
+from __future__ import annotations
+
+import os
+import stat
+from datetime import datetime, timezone
+from typing import TextIO
+
+from dissect.target.exceptions import FileNotFoundError
+from dissect.target.filesystem import FilesystemEntry, LayerFilesystemEntry
+from dissect.target.helpers import fsutil
+from dissect.target.helpers.fsutil import TargetPath
+
+# ['mode', 'addr', 'dev', 'nlink', 'uid', 'gid', 'size', 'atime', 'mtime', 'ctime']
+STAT_TEMPLATE = """  File: {path} {symlink}
+  Size: {size}       Blocks: {blocks}    IO Block: {blksize}     {filetype}
+Device: {device}     Inode: {inode}      Links: {nlink}
+Access: ({modeord}/{modestr})  Uid: ( {uid} )   Gid: ( {gid} )
+Access: {atime}
+Modify: {mtime}
+Change: {ctime}
+ Birth: {btime}"""
+
+FALLBACK_LS_COLORS = "rs=0:di=01;34:ln=01;36:mh=00:pi=40;33:so=01;35:do=01;35:bd=40;33;01:cd=40;33;01:or=40;31;01:mi=00:su=37;41:sg=30;43:ca=30;41:tw=30;42:ow=34;42:st=37;44:ex=01;32"  # noqa: E501
+
+
+def prepare_ls_colors() -> dict[str, str]:
+    """Parse the LS_COLORS environment variable so we can use it later."""
+    d = {}
+    ls_colors = os.environ.get("LS_COLORS", FALLBACK_LS_COLORS)
+    for line in ls_colors.split(":"):
+        if not line:
+            continue
+
+        ft, _, value = line.partition("=")
+        if ft.startswith("*"):
+            ft = ft[1:]
+
+        d[ft] = f"\x1b[{value}m{{}}\x1b[0m"
+
+    return d
+
+
+LS_COLORS = prepare_ls_colors()
+
+
+def fmt_ls_colors(ft: str, name: str) -> str:
+    """Helper method to colorize strings according to LS_COLORS."""
+    try:
+        return LS_COLORS[ft].format(name)
+    except KeyError:
+        pass
+
+    try:
+        return LS_COLORS[fsutil.splitext(name)[1]].format(name)
+    except KeyError:
+        pass
+
+    return name
+
+
+def human_size(bytes: int, units: list[str] = ["", "K", "M", "G", "T", "P", "E"]) -> str:
+    """Helper function to return the human readable string representation of bytes."""
+    return str(bytes) + units[0] if bytes < 1024 else human_size(bytes >> 10, units[1:])
+
+
+def stat_modestr(st: fsutil.stat_result) -> str:
+    """Helper method for generating a mode string from a numerical mode value."""
+    return stat.filemode(st.st_mode)
+
+
+def print_extensive_file_stat_listing(
+    stdout: TextIO,
+    name: str,
+    entry: FilesystemEntry | None = None,
+    timestamp: datetime | None = None,
+    human_readable: bool = False,
+) -> None:
+    """Print the file status as a single line."""
+    if entry is not None:
+        try:
+            entry_stat = entry.lstat()
+            if timestamp is None:
+                timestamp = entry_stat.st_mtime
+            symlink = f" -> {entry.readlink()}" if entry.is_symlink() else ""
+            utc_time = datetime.fromtimestamp(timestamp, tz=timezone.utc).isoformat(timespec="microseconds")
+            size = f"{human_size(entry_stat.st_size):5s}" if human_readable else f"{entry_stat.st_size:10d}"
+
+            print(
+                (
+                    f"{stat_modestr(entry_stat)} {entry_stat.st_uid:4d} {entry_stat.st_gid:4d} {size} "
+                    f"{utc_time} {name}{symlink}"
+                ),
+                file=stdout,
+            )
+            return
+        except FileNotFoundError:
+            pass
+
+    hr_spaces = f"{'':5s}" if human_readable else " "
+    regular_spaces = f"{'':10s}" if not human_readable else " "
+
+    print(f"??????????    ?    ?{regular_spaces}?{hr_spaces}????-??-??T??:??:??.??????+??:?? {name}", file=stdout)
+
+
+def ls_scandir(path: fsutil.TargetPath, color: bool = False) -> list[tuple[fsutil.TargetPath, str]]:
+    """List a directory for the given path."""
+    result = []
+    if not path.exists() or not path.is_dir():
+        return []
+
+    for file_ in path.iterdir():
+        file_type = None
+        if color:
+            if file_.is_symlink():
+                file_type = "ln"
+            elif file_.is_dir():
+                file_type = "di"
+            elif file_.is_file():
+                file_type = "fi"
+
+        result.append((file_, fmt_ls_colors(file_type, file_.name) if color else file_.name))
+
+        # If we happen to scan an NTFS filesystem see if any of the
+        # entries has an alternative data stream and also list them.
+        entry = file_.get()
+        if isinstance(entry, LayerFilesystemEntry):
+            if entry.entries.fs.__type__ == "ntfs":
+                attrs = entry.lattr()
+                for data_stream in attrs.DATA:
+                    if data_stream.name != "":
+                        name = f"{file_.name}:{data_stream.name}"
+                        result.append((file_, fmt_ls_colors(file_type, name) if color else name))
+
+    result.sort(key=lambda e: e[0].name)
+
+    return result
+
+
+def print_ls(
+    path: fsutil.TargetPath,
+    depth: int,
+    stdout: TextIO,
+    long_listing: bool = False,
+    human_readable: bool = False,
+    recursive: bool = False,
+    use_ctime: bool = False,
+    use_atime: bool = False,
+    color: bool = True,
+) -> None:
+    """Print ls output"""
+    subdirs = []
+
+    if path.is_dir():
+        contents = ls_scandir(path, color)
+    elif path.is_file():
+        contents = [(path, path.name)]
+
+    if depth > 0:
+        print(f"\n{str(path)}:", file=stdout)
+
+    if not long_listing:
+        for target_path, name in contents:
+            print(name, file=stdout)
+            if target_path.is_dir():
+                subdirs.append(target_path)
+    else:
+        if len(contents) > 1:
+            print(f"total {len(contents)}", file=stdout)
+        for target_path, name in contents:
+            try:
+                entry = target_path.get()
+                entry_stat = entry.lstat()
+                show_time = entry_stat.st_mtime
+                if use_ctime:
+                    show_time = entry_stat.st_ctime
+                elif use_atime:
+                    show_time = entry_stat.st_atime
+            except FileNotFoundError:
+                entry = None
+                show_time = None
+            print_extensive_file_stat_listing(stdout, name, entry, show_time, human_readable)
+            if target_path.is_dir():
+                subdirs.append(target_path)
+
+    if recursive and subdirs:
+        for subdir in subdirs:
+            print_ls(subdir, depth + 1, stdout, long_listing, human_readable, recursive, use_ctime, use_atime, color)
+
+
+def print_stat(path: fsutil.TargetPath, stdout: TextIO, dereference: bool = False) -> None:
+    """Print file status."""
+    symlink = f"-> {path.readlink()}" if path.is_symlink() else ""
+    s = path.stat() if dereference else path.lstat()
+
+    def filetype(path: TargetPath) -> str:
+        if path.is_dir():
+            return "directory"
+        elif path.is_symlink():
+            return "symbolic link"
+        elif path.is_file():
+            return "regular file"
+
+    res = STAT_TEMPLATE.format(
+        path=path,
+        symlink=symlink,
+        size=s.st_size,
+        filetype=filetype(path),
+        device="?",
+        inode=s.st_ino,
+        blocks=s.st_blocks or "?",
+        blksize=s.st_blksize or "?",
+        nlink=s.st_nlink,
+        modeord=oct(stat.S_IMODE(s.st_mode)),
+        modestr=stat_modestr(s),
+        uid=s.st_uid,
+        gid=s.st_gid,
+        atime=datetime.fromtimestamp(s.st_atime, tz=timezone.utc).isoformat(timespec="microseconds"),
+        mtime=datetime.fromtimestamp(s.st_mtime, tz=timezone.utc).isoformat(timespec="microseconds"),
+        ctime=datetime.fromtimestamp(s.st_ctime, tz=timezone.utc).isoformat(timespec="microseconds"),
+        btime=datetime.fromtimestamp(s.st_birthtime, tz=timezone.utc).isoformat(timespec="microseconds")
+        if hasattr(s, "st_birthtime") and s.st_birthtime
+        else "?",
+    )
+    print(res, file=stdout)
+
+    try:
+        if (xattr := path.get().attr()) and isinstance(xattr, list) and hasattr(xattr[0], "name"):
+            print("  Attr:")
+            print_xattr(path.name, xattr, stdout)
+    except Exception:
+        pass
+
+
+def print_xattr(basename: str, xattr: list, stdout: TextIO) -> None:
+    """Mimics getfattr -d {file} behaviour."""
+    if not hasattr(xattr[0], "name"):
+        return
+
+    XATTR_TEMPLATE = "# file: {basename}\n{attrs}"
+    res = XATTR_TEMPLATE.format(
+        basename=basename, attrs="\n".join([f'{attr.name}="{attr.value.decode()}"' for attr in xattr])
+    )
+    print(res, file=stdout)

dissect/target/tools/info.py

@@ -4,6 +4,7 @@
 import argparse
 import json
 import logging
+from datetime import datetime
 from pathlib import Path
 from typing import Union
 
@@ -12,6 +13,7 @@ from dissect.target.exceptions import TargetError
 from dissect.target.helpers.record import TargetRecordDescriptor
 from dissect.target.tools.query import record_output
 from dissect.target.tools.utils import (
+    args_to_uri,
     catch_sigpipe,
     configure_generic_arguments,
     process_generic_arguments,
@@ -50,14 +52,14 @@ def main():
     )
     parser.add_argument("targets", metavar="TARGETS", nargs="*", help="Targets to display info from")
     parser.add_argument("--from-file", nargs="?", type=Path, help="file containing targets to load")
-    parser.add_argument("-d", "--delimiter", default=" ", action="store", metavar="','")
     parser.add_argument("-s", "--strings", action="store_true", help="print output as string")
     parser.add_argument("-r", "--record", action="store_true", help="print output as record")
     parser.add_argument("-j", "--json", action="store_true", help="output records as pretty json")
     parser.add_argument("-J", "--jsonlines", action="store_true", help="output records as one-line json")
+    parser.add_argument("-L", "--loader", action="store", default=None, help="select a specific loader (i.e. vmx, raw)")
     configure_generic_arguments(parser)
 
-    args = parser.parse_args()
+    args, rest = parser.parse_known_args()
 
     process_generic_arguments(args)
 
@@ -73,8 +75,10 @@ def main():
             targets = targets[:-1]
         args.targets = targets
 
+    targets = args_to_uri(args.targets, args.loader, rest) if args.loader else args.targets
+
     try:
-        for i, target in enumerate(Target.open_all(args.targets)):
+        for i, target in enumerate(Target.open_all(targets)):
             try:
                 if args.jsonlines:
                     print(json.dumps(get_target_info(target), default=str))
@@ -135,10 +139,13 @@ def print_target_info(target: Target) -> None:
         if isinstance(value, list):
             value = ", ".join(value)
 
+        if isinstance(value, datetime):
+            value = value.isoformat(timespec="microseconds")
+
         if name == "hostname":
             print()
 
-        print(f"{name.capitalize().replace('_', ' ')}" + (14 - len(name)) * " " + f" : {value}")
+        print(f"{name.capitalize().replace('_', ' '):14s} : {value}")
 
 
 def get_disks_info(target: Target) -> list[dict[str, Union[str, int]]]:

dissect/target/tools/query.py

@@ -5,7 +5,7 @@ import argparse
 import logging
 import pathlib
 import sys
-from datetime import datetime
+from datetime import datetime, timezone
 from typing import Callable
 
 from flow.record import RecordPrinter, RecordStreamWriter, RecordWriter
@@ -390,7 +390,7 @@ def main():
         log.debug("", exc_info=e)
         parser.exit(1)
 
-    timestamp = datetime.utcnow()
+    timestamp = datetime.now(tz=timezone.utc)
 
     execution_report.set_plugin_stats(PLUGINS)
     log.debug("%s", execution_report.get_formatted_report())