sandbox-cli 0.2.43__tar.gz → 0.2.45__tar.gz

{sandbox_cli-0.2.43 → sandbox_cli-0.2.45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sandbox-cli
-Version: 0.2.43
+Version: 0.2.45
 Summary: Command line tool for interaction with sandboxes
 Project-URL: Homepage, https://github.com/Security-Experts-Community/sandbox-cli
 Project-URL: Documentation, https://security-experts-community.github.io/sandbox-cli
@@ -17,7 +17,7 @@ Requires-Dist: colorama>=0.4.6
 Requires-Dist: cryptography>=46.0.2
 Requires-Dist: cyclopts>=4.2.5
 Requires-Dist: docker>=7.1.0
-Requires-Dist: ptsandbox>=5.0.6
+Requires-Dist: ptsandbox>=5.0.8
 Requires-Dist: pyzipper>=0.3.6
 Requires-Dist: rich>=14.1.0
 Requires-Dist: zstandard>=0.23.0

{sandbox_cli-0.2.43 → sandbox_cli-0.2.45}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sandbox-cli"
-version = "0.2.43"
+version = "0.2.45"
 description = "Command line tool for interaction with sandboxes"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -14,7 +14,7 @@ dependencies = [
   "cryptography>=46.0.2",
   "cyclopts>=4.2.5",
   "docker>=7.1.0",
-  "ptsandbox>=5.0.6",
+  "ptsandbox>=5.0.8",
   "pyzipper>=0.3.6",
   "rich>=14.1.0",
   "zstandard>=0.23.0",

{sandbox_cli-0.2.43 → sandbox_cli-0.2.45}/sandbox_cli/cli/scanner/__init__.py

@@ -494,7 +494,7 @@ async def scan_new(
         Path | None,
         Parameter(
             name=["--syscall-hooks", "-s"],
-            help="Path to files with syscall hooks (file with syscall names splitted by newline)",
+            help="Path to file with syscall hooks (file with syscall names splitted by newline)",
             group="Sandbox Options",
         ),
     ] = None,
@@ -506,6 +506,22 @@ async def scan_new(
             group="Sandbox Options",
         ),
     ] = None,
+    unimon_hooks: Annotated[
+        Path | None,
+        Parameter(
+            name=["--unimon-hooks", "-u"],
+            help="Path to file with unimon hooks",
+            group="Sandbox Options",
+        ),
+    ] = None,
+    fileextractor_excludes: Annotated[
+        Path | None,
+        Parameter(
+            name=["--fileextractor-excludes", "-fe"],
+            help="Path to file with fileextractor excludes",
+            group="Sandbox Options",
+        ),
+    ] = None,
     custom_command: Annotated[
         str | None,
         Parameter(
@@ -540,6 +556,15 @@ async def scan_new(
             negative="",
         ),
     ] = False,
+    disable_lightweight_dumps: Annotated[
+        bool,
+        Parameter(
+            name=["--disable-lightweight-dumps", "-dl"],
+            help="Disable lightweight memory dumps (mostly for testing purposes)",
+            group="Sandbox Options",
+            negative="",
+        ),
+    ] = False,
     bootkitmon: Annotated[
         bool,
         Parameter(
@@ -729,12 +754,15 @@ async def scan_new(
         is_local=is_local,
         analysis_duration=analysis_duration,
         syscall_hooks=syscall_hooks,
+        unimon_hooks=unimon_hooks,
         custom_command=custom_command,
         dll_hooks_dir=dll_hooks_dir,
+        fileextractor_excludes=fileextractor_excludes,
         fake_name=fake_name,
         unpack=unpack,
         priority=priority,
         no_procdumps_on_finish=no_procdumps_on_finish,
+        disable_lightweight_dumps=disable_lightweight_dumps,
         bootkitmon=bootkitmon,
         bootkitmon_duration=bootkitmon_duration,
         mitm_disabled=mitm_disabled,

{sandbox_cli-0.2.43 → sandbox_cli-0.2.45}/sandbox_cli/utils/scanner/advanced.py

@@ -91,9 +91,12 @@ async def _prepare_sandbox_new_scan(
     is_local: bool,
     analysis_duration: int,
     syscall_hooks: Path | None,
+    unimon_hooks: Path | None,
     dll_hooks_dir: Path | None,
+    filextractor_excludes: Path | None,
     custom_command: str | None,
     no_procdumps_on_finish: bool,
+    disable_lightweight_dumps: bool,
     bootkitmon: bool,
     bootkitmon_duration: int,
     mitm_disabled: bool,
@@ -155,6 +158,8 @@ async def _prepare_sandbox_new_scan(
     # all debug options available in library
     sandbox_options.debug_options["save_debug_files"] = True
     sandbox_options.debug_options["extract_crashdumps"] = True
+    # by default we want to use lightweight memory dumps
+    sandbox_options.debug_options["procdump_lightweight_mode"] = not disable_lightweight_dumps
 
     # process custom options
     compiled_rules = await _get_compiled_rules(rules_dir=rules_dir, is_local=is_local, progress=progress)
@@ -170,12 +175,26 @@ async def _prepare_sandbox_new_scan(
         syscall_hooks_uri = (await sandbox.api.upload_file(data)).data.file_uri
         sandbox_options.debug_options["custom_syscall_hooks"] = syscall_hooks_uri
 
+    if unimon_hooks:
+        progress.console.print(f"{console.INFO} Upload unimon hooks: {unimon_hooks}")
+        async with aiofiles.open(unimon_hooks, mode="rb") as fd:
+            data = await fd.read()
+        unimon_hooks_uri = (await sandbox.api.upload_file(data)).data.file_uri
+        sandbox_options.debug_options["custom_unimon_hooks"] = unimon_hooks_uri
+
     if dll_hooks_dir:
         progress.console.print(f"{console.INFO} Upload dll hooks: {dll_hooks_dir}")
         data = merge_dll_hooks(Path(dll_hooks_dir))
         dll_hooks_uri = (await sandbox.api.upload_file(data)).data.file_uri
         sandbox_options.debug_options["custom_dll_hooks"] = dll_hooks_uri
 
+    if filextractor_excludes:
+        progress.console.print(f"{console.INFO} Upload fileextractor excludes: {filextractor_excludes}")
+        async with aiofiles.open(filextractor_excludes, mode="rb") as fd:
+            data = await fd.read()
+        fileextractor_excludes_uri = (await sandbox.api.upload_file(data)).data.file_uri
+        sandbox_options.debug_options["custom_fileextractor_exclude"] = fileextractor_excludes_uri
+
     if custom_command:
         progress.console.print(f"{console.INFO} Commandline: {custom_command}")
         sandbox_options.custom_command = custom_command
@@ -205,12 +224,15 @@ async def scan_internal_advanced(
     is_local: bool,
     analysis_duration: int,
     syscall_hooks: Path | None,
+    unimon_hooks: Path | None,
     dll_hooks_dir: Path | None,
+    fileextractor_excludes: Path | None,
     custom_command: str | None,
     fake_name: str | None,
     unpack: bool,
     priority: int,
     no_procdumps_on_finish: bool,
+    disable_lightweight_dumps: bool,
     bootkitmon: bool,
     bootkitmon_duration: int,
     mitm_disabled: bool,
@@ -376,23 +398,26 @@ async def scan_internal_advanced(
     tasks: list[Coroutine[Any, Any, None]] = []
     with progress:
         sandbox, sandbox_options, images = await _prepare_sandbox_new_scan(
-            progress,
-            scan_images,
-            rules_dir,
-            key,
-            is_local,
-            analysis_duration,
-            syscall_hooks,
-            dll_hooks_dir,
-            custom_command,
-            no_procdumps_on_finish,
-            bootkitmon,
-            bootkitmon_duration,
-            mitm_disabled,
-            disable_clicker,
-            skip_sample_run,
-            vnc_mode,
-            outbound_connections,
+            progress=progress,
+            scan_images=scan_images,
+            rules_dir=rules_dir,
+            sandbox_key=key,
+            is_local=is_local,
+            analysis_duration=analysis_duration,
+            syscall_hooks=syscall_hooks,
+            unimon_hooks=unimon_hooks,
+            dll_hooks_dir=dll_hooks_dir,
+            filextractor_excludes=fileextractor_excludes,
+            custom_command=custom_command,
+            no_procdumps_on_finish=no_procdumps_on_finish,
+            disable_lightweight_dumps=disable_lightweight_dumps,
+            bootkitmon=bootkitmon,
+            bootkitmon_duration=bootkitmon_duration,
+            mitm_disabled=mitm_disabled,
+            disable_clicker=disable_clicker,
+            skip_sample_run=skip_sample_run,
+            vnc_mode=vnc_mode,
+            outbound_connections=outbound_connections,
         )
         max_image_length = max(len(x) for x in images)
         for i, image_id in enumerate(images):