make --list-children usable without required args. Fixes to target-info.

Author: lhaagsma

dissect/target/tools/info.py

@@ -80,17 +80,18 @@ def main() -> int:
     try:
         for i, target in enumerate(open_targets(args)):
             try:
+                target_info = get_target_info(target, args)
                 if args.jsonlines:
-                    print(json.dumps(get_target_info(target), default=str))
+                    print(json.dumps(target_info, default=str))
                 elif args.json:
-                    print(json.dumps(get_target_info(target), indent=4, default=str))
+                    print(json.dumps(target_info, indent=4, default=str))
                 elif args.record:
                     rs = record_output(args.strings)
-                    rs.write(InfoRecord(**get_target_info(target), _target=target))
+                    rs.write(InfoRecord(**target_info, _target=target))
                 else:
                     if i > 0:
                         print("-" * 70)
-                    print_target_info(target)
+                    print_target_info(target, target_info)
             except Exception as e:  # noqa: PERF203
                 target.log.error("Exception in retrieving information for target: `%s`, use `-vv` for details", target)  # noqa: TRY400
                 target.log.debug("", exc_info=e)
@@ -102,11 +103,11 @@ def main() -> int:
     return 0
 
 
-def get_target_info(target: Target) -> dict[str, str | list[str]]:
+def get_target_info(target: Target, args: argparse.Namespace) -> dict[str, str | list[str]]:
     return {
         "disks": get_disks_info(target),
         "volumes": get_volumes_info(target),
-        "children": get_children_info(target),
+        "children": get_children_info(target, args.recursive),
         "hostname": target.hostname,
         "domain": get_optional_func(target, "domain"),
         "ips": target.ips,
@@ -126,10 +127,10 @@ def get_optional_func(target: Target, func: str) -> str | None:
     return None
 
 
-def print_target_info(target: Target) -> None:
+def print_target_info(target: Target, target_info: dict[str, str | list[str]]) -> None:
     print(target)
 
-    for name, value in get_target_info(target).items():
+    for name, value in target_info.items():
         if name in ["disks", "volumes", "children"]:
             if not any(value):
                 continue
@@ -161,8 +162,14 @@ def get_volumes_info(target: Target) -> list[dict[str, str | int]]:
 
 def get_children_info(target: Target, recursive: bool = False) -> list[dict[str, str]]:
     if recursive:
-        return [{"child_index": i, "type": c.type, "path": str(c.path)} for i, c in target.list_children_recursive()]
-    return [{"child_index": i, "type": c.type, "path": str(c.path)} for i, c in enumerate(target.list_children())]
+        return [
+            {"child_index": i, "name": c.name, "type": c.type, "path": str(c.path)}
+            for i, c in target.list_children_recursive()
+        ]
+    return [
+        {"child_index": i, "name": c.name, "type": c.type, "path": str(c.path)}
+        for i, c in enumerate(target.list_children())
+    ]
 
 
 if __name__ == "__main__":

dissect/target/tools/utils.py

@@ -42,6 +42,21 @@
 USAGE_FORMAT_TMPL = "{prog} -f {name}{usage}"
 
 
+class list_children_action(argparse.Action):
+    def __init__(
+        self, option_strings: list, dest: str = argparse.SUPPRESS, default: str = argparse.SUPPRESS, help: None = None
+    ):
+        super().__init__(option_strings=option_strings, dest=dest, default=default, nargs=0, help=help)
+
+    def __call__(
+        self, parser: argparse.ArgumentParser, namespace: argparse.Namespace, values: list, option_string: None = None
+    ):
+        for action in parser._get_positional_actions():
+            action.required = False
+
+        namespace.list_children = True
+
+
 def configure_generic_arguments(parser: argparse.ArgumentParser) -> None:
     parser.add_argument("-K", "--keychain-file", type=Path, help="keychain file in CSV format")
     parser.add_argument("-Kv", "--keychain-value", help="passphrase, recovery key or key file path value")
@@ -52,14 +67,13 @@ def configure_generic_arguments(parser: argparse.ArgumentParser) -> None:
     parser.add_argument("--children", action="store_true", help="include children")
     parser.add_argument(
         "--list-children",
-        action=argparse.BooleanOptionalAction,
+        action=list_children_action,
         help="list all children by index and path output to be used in --child - does not process anything",
     )
     parser.add_argument(
-        "--list-children-recursive",
-        action=argparse.BooleanOptionalAction,
-        default=False,
-        help="list all children (recursively) by index and path - does not process anything",
+        "--recursive",
+        action="store_true",
+        help="Makes --list-children behave recursively - does not process anything",
     )
     parser.add_argument("-v", "--verbose", action="count", default=0, help="increase output verbosity")
     parser.add_argument("--version", action="store_true", help="print version")
@@ -97,10 +111,11 @@ def process_generic_arguments(args: argparse.Namespace, rest: list[str]) -> None
         sys.exit(1)
 
     # List found children on targets and exit
-    if args.list_children or args.list_children_recursive:
+    if hasattr(args, "list_children"):
+        # List found children on targets and exit
         # Using open_targets here breaks with target-fs due to target vs targets
         list_target = Target.open_all(targets, args.children)
-        print_children(list_target, recursive=args.list_children_recursive)
+        print_children(list_target, recursive=args.recursive)
         sys.exit(0)
 
     if args.keychain_file: