dissect.target 3.17.dev12__tar.gz → 3.17.dev13__tar.gz

{dissect.target-3.17.dev12/dissect.target.egg-info → dissect.target-3.17.dev13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.17.dev12
+Version: 3.17.dev13
 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.17.dev12 → dissect.target-3.17.dev13}/dissect/target/tools/dump/run.py

@@ -7,7 +7,7 @@ import sys
 from collections import deque
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Generator, Iterable, List, Optional, Tuple
+from typing import Any, Iterable, Iterator, Optional
 
 import structlog
 from flow.record import Record
@@ -25,10 +25,12 @@ from dissect.target.tools.dump.utils import (
     Compression,
     Serialization,
     cached_sink_writers,
-    get_nested_attr,
 )
 from dissect.target.tools.utils import (
+    PluginFunction,
     configure_generic_arguments,
+    execute_function_on_target,
+    find_and_filter_plugins,
     process_generic_arguments,
 )
 
@@ -44,13 +46,13 @@ class RecordStreamElement:
     sink_path: Optional[Path] = None
 
 
-def get_targets(targets: List[str]) -> Generator[Target, None, None]:
+def get_targets(targets: list[str]) -> Iterator[Target]:
     """Return a generator with `Target` objects for provided paths"""
     for target in Target.open_all(targets):
         yield target
 
 
-def execute_function(target: Target, function: str) -> Generator[TargetRecordDescriptor, None, None]:
+def execute_function(target: Target, function: PluginFunction) -> TargetRecordDescriptor:
     """
     Execute function `function` on provided target `target` and return a generator
     with the records produced.
@@ -62,7 +64,7 @@ def execute_function(target: Target, function: str) -> Generator[TargetRecordDes
     local_log.debug("Function execution")
 
     try:
-        target_attr = get_nested_attr(target, function)
+        output_type, target_attr, _ = execute_function_on_target(target, function)
     except UnsupportedPluginError:
         local_log.error("Function is not supported for target", exc_info=True)
         return
@@ -70,15 +72,8 @@ def execute_function(target: Target, function: str) -> Generator[TargetRecordDes
         local_log.error("Plugin error while executing function for target", exc_info=True)
         return
 
-    # skip non-record outputs
-    try:
-        output = getattr(target_attr, "__output__", "default") if hasattr(target_attr, "__output__") else None
-    except PluginError as e:
-        local_log.error("Plugin error while fetching an attribute", exc_info=e)
-        return
-
-    if output != "record":
-        local_log.warn("Output format is not supported", output=output)
+    if output_type != "record":
+        local_log.warn("Output format is not supported", output=output_type)
         return
 
     # no support for function-specific arguments
@@ -94,9 +89,9 @@ def execute_function(target: Target, function: str) -> Generator[TargetRecordDes
 
 def produce_target_func_pairs(
     targets: Iterable[Target],
-    functions: List[str],
+    functions: str,
     state: DumpState,
-) -> Generator[Tuple[Target, str], None, None]:
+) -> Iterator[tuple[Target, PluginFunction]]:
     """
     Return a generator with target and function pairs for execution.
 
@@ -107,20 +102,20 @@ def produce_target_func_pairs(
         pairs_to_skip.update((str(sink.target_path), sink.func) for sink in state.finished_sinks)
 
     for target in targets:
-        for func in functions:
-            if state and (target.path, func) in pairs_to_skip:
+        for func_def in find_and_filter_plugins(target, functions):
+            if state and (target.path, func_def.name) in pairs_to_skip:
                 log.info(
                     "Skipping target/func pair since its marked as done in provided state",
                     target=target.path,
-                    func=func,
+                    func=func_def.name,
                     state=state.path,
                 )
                 continue
-            yield (target, func)
-            state.mark_as_finished(target, func)
+            yield (target, func_def)
+            state.mark_as_finished(target, func_def.name)
 
 
-def execute_functions(target_func_stream: Iterable[Tuple[Target, str]]) -> Generator[RecordStreamElement, None, None]:
+def execute_functions(target_func_stream: Iterable[tuple[Target, str]]) -> Iterable[RecordStreamElement]:
     """
     Execute a function on a target for target / function pairs in the stream.
 
@@ -131,7 +126,7 @@ def execute_functions(target_func_stream: Iterable[Tuple[Target, str]]) -> Gener
             yield RecordStreamElement(target=target, func=func, record=record)
 
 
-def log_progress(stream: Iterable[Any], step_size: int = 1000) -> Generator[Any, None, None]:
+def log_progress(stream: Iterable[Any], step_size: int = 1000) -> Iterable[Any]:
     """
     Log a number of items that went though the generator stream
     after every N element (N is configured in `step_size`).
@@ -155,7 +150,7 @@ def log_progress(stream: Iterable[Any], step_size: int = 1000) -> Generator[Any,
 def sink_records(
     record_stream: Iterable[RecordStreamElement],
     state: DumpState,
-) -> Generator[RecordStreamElement, None, None]:
+) -> Iterator[RecordStreamElement]:
     """
     Persist records from the stream into appropriate sinks, per serialization, compression and record type.
     """
@@ -168,7 +163,7 @@ def sink_records(
 def persist_processing_state(
     record_stream: Iterable[RecordStreamElement],
     state: DumpState,
-) -> Generator[RecordStreamElement, None, None]:
+) -> Iterator[RecordStreamElement]:
     """
     Keep track of the pipeline state in a persistent state object.
     """
@@ -179,8 +174,8 @@ def persist_processing_state(
 
 
 def execute_pipeline(
-    targets: List[str],
-    functions: List[str],
+    targets: list[str],
+    functions: str,
     output_dir: Path,
     serialization: Serialization,
     compression: Optional[Compression] = None,
@@ -297,7 +292,7 @@ def main():
     try:
         execute_pipeline(
             targets=args.targets,
-            functions=args.function.split(","),
+            functions=args.function,
             output_dir=args.output,
             serialization=Serialization(args.serialization),
             compression=Compression(args.compression),

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13}/dissect/target/tools/dump/state.py

@@ -6,7 +6,7 @@ import json
 from contextlib import contextmanager
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Any, Callable, Iterator, List, Optional, TextIO
+from typing import Any, Callable, Iterator, Optional, TextIO
 
 import structlog
 
@@ -35,17 +35,20 @@ class Sink:
     record_count: int = 0
     size_bytes: int = 0
 
+    def __post_init__(self):
+        self.func = getattr(self.func, "name", self.func)
+
 
 @dataclass
 class DumpState:
-    target_paths: List[str]
-    functions: List[str]
+    target_paths: list[str]
+    functions: list[str]
     serialization: str
     compression: str
     start_time: datetime.datetime
     last_update_time: datetime.datetime
 
-    sinks: List[Sink] = dataclasses.field(default_factory=list)
+    sinks: list[Sink] = dataclasses.field(default_factory=list)
 
     # Volatile properties
     output_dir: Optional[Path] = None
@@ -56,7 +59,7 @@ class DumpState:
         return sum(s.record_count for s in self.sinks)
 
     @property
-    def finished_sinks(self) -> List[Sink]:
+    def finished_sinks(self) -> list[Sink]:
         return [sink for sink in self.sinks if not sink.is_dirty]
 
     @property
@@ -178,7 +181,7 @@ class DumpState:
         state.output_dir = output_dir
         return state
 
-    def get_invalid_sinks(self) -> List[Sink]:
+    def get_invalid_sinks(self) -> list[Sink]:
         """Return sinks that have a mismatch between recorded size and a real file size"""
         invalid_sinks = []
         for sink in self.sinks:
@@ -214,8 +217,8 @@ class DumpState:
 def create_state(
     *,
     output_dir: Path,
-    target_paths: List[str],
-    functions: List[str],
+    target_paths: list[str],
+    functions: list[str],
     serialization: Serialization,
     compression: Compression = None,
 ) -> DumpState:

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13}/dissect/target/tools/dump/utils.py

@@ -32,6 +32,7 @@ from flow.record.adapter.jsonfile import JsonfileWriter
 from flow.record.jsonpacker import JsonRecordPacker
 
 from dissect.target import Target
+from dissect.target.plugin import PluginFunction
 
 log = structlog.get_logger(__name__)
 
@@ -69,14 +70,14 @@ def get_nested_attr(obj: Any, nested_attr: str) -> Any:
 
 
 @lru_cache(maxsize=DEST_DIR_CACHE_SIZE)
-def get_sink_dir_by_target(target: Target, function: str) -> Path:
-    func_first_name, _, _ = function.partition(".")
+def get_sink_dir_by_target(target: Target, function: PluginFunction) -> Path:
+    func_first_name, _, _ = function.name.partition(".")
     return Path(target.name) / func_first_name
 
 
 @functools.lru_cache(maxsize=DEST_DIR_CACHE_SIZE)
-def get_sink_dir_by_func(target: Target, function: str) -> Path:
-    func_first_name, _, _ = function.partition(".")
+def get_sink_dir_by_func(target: Target, function: PluginFunction) -> Path:
+    func_first_name, _, _ = function.name.partition(".")
     return Path(func_first_name) / target.name
 
 

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13}/dissect/target/tools/query.py

@@ -26,6 +26,7 @@ from dissect.target.tools.utils import (
     catch_sigpipe,
     configure_generic_arguments,
     execute_function_on_target,
+    find_and_filter_plugins,
     generate_argparse_for_bound_method,
     generate_argparse_for_plugin_class,
     generate_argparse_for_unbound_method,
@@ -270,25 +271,13 @@ def main():
             basic_entries = []
             yield_entries = []
 
-            # Keep a set of plugins that were already executed on the target.
-            executed_plugins = set()
-
             first_seen_output_type = default_output_type
             cli_params_unparsed = rest
 
-            func_defs, _ = find_plugin_functions(target, args.function, compatibility=False)
             excluded_funcs, _ = find_plugin_functions(target, args.excluded_functions, compatibility=False)
             excluded_func_paths = {excluded_func.path for excluded_func in excluded_funcs}
 
-            for func_def in func_defs:
-                if func_def.path in excluded_func_paths:
-                    continue
-
-                # Avoid executing same plugin for multiple OSes (like hostname)
-                if func_def.name in executed_plugins:
-                    continue
-                executed_plugins.add(func_def.name)
-
+            for func_def in find_and_filter_plugins(target, args.function, excluded_func_paths):
                 # If the default type is record (meaning we skip everything else)
                 # and actual output type is not record, continue.
                 # We perform this check here because plugins that require output files/dirs

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13}/dissect/target/tools/utils.py

@@ -21,6 +21,7 @@ from dissect.target.plugin import (
     OSPlugin,
     Plugin,
     PluginFunction,
+    find_plugin_functions,
     get_external_module_paths,
     load_modules_from_paths,
 )
@@ -289,3 +290,25 @@ def args_to_uri(targets: list[str], loader_name: str, rest: list[str]) -> list[s
     for target in targets:
         uris.append(f"{loader_name}://{target}" + (("?" + urllib.parse.urlencode(args)) if args else ""))
     return uris
+
+
+def find_and_filter_plugins(
+    target: Target, functions: str, excluded_func_paths: set[str] = None
+) -> Iterator[PluginFunction]:
+    # Keep a set of plugins that were already executed on the target.
+    executed_plugins = set()
+    excluded_func_paths = excluded_func_paths or set()
+
+    func_defs, _ = find_plugin_functions(target, functions, compatibility=False)
+
+    for func_def in func_defs:
+        if func_def.path in excluded_func_paths:
+            continue
+
+        # Avoid executing same plugin for multiple OSes (like hostname)
+        if func_def.name in executed_plugins:
+            continue
+
+        executed_plugins.add(func_def.name)
+
+        yield func_def

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13/dissect.target.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dissect.target
-Version: 3.17.dev12
+Version: 3.17.dev13
 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.17.dev12 → dissect.target-3.17.dev13}/tests/tools/test_dump.py

@@ -62,7 +62,7 @@ def test_execute_pipeline(
         serialization = utils.Serialization(serialization_name)
         compression = utils.Compression(compression_name)
 
-        functions = ["iis.logs", "amcache.applications"]
+        functions = "iis.logs,amcache.applications"
 
         run.execute_pipeline(
             targets=["dummy"],
@@ -112,7 +112,7 @@ def test_execute_pipeline(
         sink_blobs = state_blob["sinks"]
 
         assert len(sink_blobs) == 2
-        assert {s["func"] for s in sink_blobs} == set(functions)
+        assert {s["func"] for s in sink_blobs} == set(functions.split(","))
 
         assert all(s["is_dirty"] is False for s in sink_blobs)
 
@@ -150,7 +150,7 @@ def test_execute_pipeline_limited(limit, target_win_iis_amcache, tmp_path):
     ):
         output_dir = tmp_path / "output"
 
-        functions = ["iis.logs", "amcache.applications"]
+        functions = "iis.logs,amcache.applications"
 
         run.execute_pipeline(
             targets=["dummy"],
@@ -203,7 +203,7 @@ def test_execute_pipeline_limited(limit, target_win_iis_amcache, tmp_path):
             assert (output_dir / target_name / "amcache" / amcache_sink_filename).exists()
 
             assert len(sink_blobs) == 2
-            assert {s["func"] for s in sink_blobs} == set(functions)
+            assert {s["func"] for s in sink_blobs} == set(functions.split(","))
 
             amcache_sink_blob = next(s for s in state_blob["sinks"] if s["func"] == "amcache.applications")
 

{dissect.target-3.17.dev12 → dissect.target-3.17.dev13}/tests/tools/test_query.py

@@ -198,6 +198,11 @@ def test_target_query_filtered_functions(monkeypatch: pytest.MonkeyPatch) -> Non
                 autospec=True,
                 side_effect=mock_find_plugin_function,
             ),
+            patch(
+                "dissect.target.tools.utils.find_plugin_functions",
+                autospec=True,
+                side_effect=mock_find_plugin_function,
+            ),
             patch(
                 "dissect.target.tools.query.execute_function_on_target",
                 autospec=True,