sandbox-cli 0.2.49__tar.gz → 0.2.50__tar.gz

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sandbox-cli
-Version: 0.2.49
+Version: 0.2.50
 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
@@ -12,14 +12,14 @@ License-File: LICENSE
 License-File: NOTICE
 Requires-Python: >=3.11
 Requires-Dist: aiofiles>=25.1.0
-Requires-Dist: asyncssh>=2.22.0
+Requires-Dist: asyncssh>=2.24.0
 Requires-Dist: colorama>=0.4.6
-Requires-Dist: cryptography>=46.0.5
-Requires-Dist: cyclopts>=4.10.2
+Requires-Dist: cryptography>=49.0.0
+Requires-Dist: cyclopts>=4.20.0
 Requires-Dist: docker>=7.1.0
-Requires-Dist: ptsandbox>=5.0.11
-Requires-Dist: pyzipper>=0.3.6
-Requires-Dist: rich>=14.3.3
+Requires-Dist: ptsandbox>=5.0.14
+Requires-Dist: pyzipper>=0.4.0
+Requires-Dist: rich>=15.0.0
 Requires-Dist: zstandard>=0.25.0
 Description-Content-Type: text/markdown
 

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sandbox-cli"
-version = "0.2.49"
+version = "0.2.50"
 description = "Command line tool for interaction with sandboxes"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -9,14 +9,14 @@ license-files = ["LICENSE", "NOTICE"]
 authors = [{ name = "Alexey Kolesnikov" }]
 dependencies = [
   "aiofiles>=25.1.0",
-  "asyncssh>=2.22.0",
+  "asyncssh>=2.24.0",
   "colorama>=0.4.6",
-  "cryptography>=46.0.5",
-  "cyclopts>=4.10.2",
+  "cryptography>=49.0.0",
+  "cyclopts>=4.20.0",
   "docker>=7.1.0",
-  "ptsandbox>=5.0.11",
-  "pyzipper>=0.3.6",
-  "rich>=14.3.3",
+  "ptsandbox>=5.0.14",
+  "pyzipper>=0.4.0",
+  "rich>=15.0.0",
   "zstandard>=0.25.0",
 ]
 
@@ -28,11 +28,12 @@ Issues = "https://github.com/Security-Experts-Community/sandbox-cli/issues"
 
 [dependency-groups]
 dev = [
-  "black>=24.10.0",
-  "isort>=5.13.2",
-  "mypy>=1.14.1",
-  "types-aiofiles>=24.1.0.20241221",
-  "types-docker>=7.1.0.20241229",
+  "black>=26.5.1",
+  "isort>=7.0.0",
+  "mypy>=2.1.0",
+  "types-aiofiles>=25.1.0.20260518",
+  "types-docker>=7.1.0.20260712",
+  "types-colorama>=0.4.15.20260508",
 ]
 docs = ["mkdocs>=1.6.1", "mkdocs-material>=9.6.7", "termynal>=0.13.0"]
 

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/cli/downloader.py

@@ -61,11 +61,11 @@ async def download_command(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
     out_dir: Annotated[
         Path,
         Parameter(
@@ -255,7 +255,7 @@ async def download_command(
             else:
                 Unpack(out_dir).run()
 
-    async def create_task(sandbox: Sandbox, task_id: str) -> None:
+    async def create_task(sandbox: Sandbox, task_id: str | UUID) -> None:
         progress_task_id = progress.add_task(description=rf"\[[green1]{task_id}[/]] fetching info", start=True)
 
         def finalize_progress() -> None:
@@ -299,7 +299,7 @@ async def download_command(
     tasks: list[Coroutine[Any, Any, Artifact.EngineResult | None]] = []
 
     if query is not None:
-        sandbox = Sandbox(get_key_by_name(key_name=key))
+        sandbox: Sandbox = Sandbox(get_key_by_name(key_name=key))
 
         limit = 40 if count > 40 else count
         viewed, next_cursor = 0, ""
@@ -312,22 +312,16 @@ async def download_command(
                 viewed += limit
                 next_cursor = response.next_cursor
 
-        # clear last line
-        sys.stdout.write("\033[F\033[K")
-
     for task in tasks_id:
-        sandbox, task_id = get_key_and_task(key, task)
-        if not sandbox or not task_id:
+        sandbox_key, task_id = get_key_and_task(key, task)
+        if not (sandbox_key and task_id):
             continue
 
-        await create_task(sandbox, task_id)
+        await create_task(sandbox_key, task_id)
 
     with progress:
         await asyncio.gather(*tasks)
 
-    # clear last line
-    sys.stdout.write("\033[F\033[K")
-
 
 def download_email(
     emails: Annotated[
@@ -349,11 +343,11 @@ def download_email(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
 ) -> None:
     """
     Upload an email and get its headers.

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/cli/images.py

@@ -15,11 +15,11 @@ async def get_images(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
 ) -> None:
     """
     Get available images in the sandbox.

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/cli/scanner/__init__.py

@@ -115,11 +115,11 @@ async def re_scan(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox Options",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
     is_local: Annotated[
         bool,
         Parameter(
@@ -233,11 +233,11 @@ async def scan(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox Options",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
     is_local: Annotated[
         bool,
         Parameter(
@@ -481,11 +481,11 @@ async def scan_new(
         str,
         Parameter(
             name=["--key", "-k"],
-            help=f"The key to access the sandbox **{'**,**'.join(x.name.get_secret_value() for x in settings.sandbox_keys)}**",
+            help=f"The key to access the sandbox **{'**,**'.join(x.name for x in settings.sandbox_keys)}**",
             validator=validate_key,
             group="Sandbox Options",
         ),
-    ] = settings.sandbox_keys[0].name.get_secret_value(),
+    ] = settings.sandbox_keys[0].name,
     is_local: Annotated[
         bool,
         Parameter(

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/internal/config.py

@@ -7,7 +7,7 @@ from typing import Any
 
 import pydantic
 from ptsandbox import SandboxKey
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, SecretStr
 
 from sandbox_cli.console import console
 
@@ -78,7 +78,7 @@ class Settings(BaseModel):
         def sandbox_key(self) -> SandboxKey:
             return SandboxKey(
                 name=self.name,
-                key=self.key,
+                key=SecretStr(self.key),
                 host=self.host,
                 max_workers=self.max_workers,
                 description=self.description,

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/internal/helpers.py

@@ -13,7 +13,7 @@ from sandbox_cli.models.sandbox_arguments import SandboxArguments
 
 def get_key_by_name(key_name: str) -> SandboxKey:
     for sandbox_key in settings.sandbox_keys:
-        if sandbox_key.name.get_secret_value() == key_name:
+        if sandbox_key.name == key_name:
             return sandbox_key
     raise KeyError()
 
@@ -30,10 +30,8 @@ def validate_key(_: Any, value: Any) -> None:
     try:
         get_key_by_name(value)
     except KeyError:
-        available = "', '".join(x.name.get_secret_value() for x in settings.sandbox_keys)
-        console.error(
-            f'Key "{value}" doesn\'t exist in config. Available keys: "{available}"'
-        )
+        available = "', '".join(x.name for x in settings.sandbox_keys)
+        console.error(f'Key "{value}" doesn\'t exist in config. Available keys: "{available}"')
         sys.exit(1)
 
 
@@ -75,15 +73,25 @@ def format_link(
 
 def save_scan_arguments(out_dir: Path, scan_args: SandboxArguments) -> None:
     scan_config_path = out_dir / "scan_config.json"
-    scan_config_path.write_text(scan_args.model_dump_json(exclude="debug_options", indent=4), encoding="utf-8")
+    scan_config_path.write_text(
+        scan_args.model_dump_json(exclude={"debug_options"}, indent=4),
+        encoding="utf-8",
+    )
 
 
 def open_link(link: str) -> None:
     if settings.browser is not None:
-        webbrowser.register("new_default_browser", None, webbrowser.GenericBrowser([settings.browser.path, *settings.browser.args]), preferred=True)
+        webbrowser.register(
+            "new_default_browser",
+            None,
+            webbrowser.GenericBrowser([str(settings.browser.path), *settings.browser.args]),
+            preferred=True,
+        )
         if not webbrowser.open(link):
             console.error("Can't open link in the specified browser. Please check browser path and args.")
         return
 
     if not webbrowser.open_new_tab(link):
-        console.error("Can't open link in the default browser. Try adding path and args for your browser to the config file.")
+        console.error(
+            "Can't open link in the default browser. Try adding path and args for your browser to the config file."
+        )

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/utils/downloader/__init__.py

@@ -40,7 +40,7 @@ async def _save_artifact(
     scan_id: UUID,
     sandbox: Sandbox,
     out_dir: Path,
-    path: Path,
+    name: str,
     file_uri: str,
     overwrite: bool = False,
     decompress: bool = False,
@@ -54,7 +54,7 @@ async def _save_artifact(
         return
 
     # sanitize path
-    path = out_dir / Path(str(path).replace(" ", "_"))
+    path = out_dir / name.replace(" ", "_")
     if not overwrite:
         n = 1
         while path.exists():
@@ -133,13 +133,13 @@ async def download(
 ) -> None:
     tasks: list[Coroutine[Any, Any, None]] = []
 
-    def add_task(out_dir: Path, path: Path, file_uri: str, decompress: bool = False, overwrite: bool = False) -> None:
+    def add_task(out_dir: Path, name: str, file_uri: str, decompress: bool = False, overwrite: bool = False) -> None:
         tasks.append(
             _save_artifact(
                 scan_id=report.scan_id,
                 sandbox=sandbox,
                 out_dir=out_dir,
-                path=path,
+                name=name,
                 file_uri=file_uri,
                 progress=progress,
                 idx=idx,
@@ -178,16 +178,34 @@ async def download(
                     LogType.EVENT_RAW,
                     LogType.NETWORK,
                 }:
-                    add_task(output, log.file_name, log.file_uri, overwrite=True)
+                    add_task(
+                        out_dir=output,
+                        name=log.file_name,
+                        file_uri=log.file_uri,
+                        overwrite=True,
+                    )
 
                 if (all or video) and log.type == LogType.SCREENSHOT:
-                    add_task(output, log.file_name, log.file_uri, overwrite=True)
+                    add_task(
+                        out_dir=output,
+                        name=log.file_name,
+                        file_uri=log.file_uri,
+                        overwrite=True,
+                    )
 
                 if (all or crashdumps) and log.file_name in {"crashdump.bin", "crashdump.metadata"}:
-                    add_task(output / "crashdumps", log.file_name, log.file_uri)
+                    add_task(
+                        out_dir=output / "crashdumps",
+                        name=log.file_name,
+                        file_uri=log.file_uri,
+                    )
 
                 if (all or debug) and log.type in {LogType.DEBUG, LogType.GRAPH}:
-                    add_task(output / "debug", log.file_name, log.file_uri)
+                    add_task(
+                        out_dir=output / "debug",
+                        name=log.file_name,
+                        file_uri=log.file_uri,
+                    )
 
             if artifacts or files or procdumps or all:
                 if not sandbox_result.details:
@@ -205,37 +223,37 @@ async def download(
 
                     if artifact.type == ArtifactType.FILE and (files or artifacts or all):
                         add_task(
-                            output / "artifacts",
-                            artifact.file_info.file_path.removeprefix("/"),
-                            artifact.file_info.file_uri,
+                            out_dir=output / "artifacts",
+                            name=artifact.file_info.file_path.removeprefix("/"),
+                            file_uri=artifact.file_info.file_uri,
                         )
                     if artifact.type == ArtifactType.PROCESS_DUMP and (procdumps or artifacts or all):
                         add_task(
-                            output / "process_dump",
-                            artifact.file_info.details.process_dump.process_name.removeprefix("/"),  # type: ignore
-                            artifact.file_info.file_uri,
+                            out_dir=output / "process_dump",
+                            name=artifact.file_info.details.process_dump.process_name.removeprefix("/"),  # type: ignore
+                            file_uri=artifact.file_info.file_uri,
                             decompress=decompress,
                         )
 
                     if artifact.type == ArtifactType.AMSI and (amsi or all):
                         add_task(
-                            output / "amsi",
-                            f"{artifact.file_info.sha256}.bin",
-                            artifact.file_info.file_uri,
+                            out_dir=output / "amsi",
+                            name=f"{artifact.file_info.sha256}.bin",
+                            file_uri=artifact.file_info.file_uri,
                         )
 
                     if artifact.type == ArtifactType.DEX_DUMP and (dex or all):
                         add_task(
-                            output / "dex",
-                            f"{artifact.file_info.sha256}.bin",
-                            artifact.file_info.file_uri,
+                            out_dir=output / "dex",
+                            name=f"{artifact.file_info.sha256}.bin",
+                            file_uri=artifact.file_info.file_uri,
                         )
 
                     if all and artifact.type not in _KNOWN_ARTIFACT_TYPES:
                         add_task(
-                            output / "other",
-                            artifact.file_info.sha256,
-                            artifact.file_info.file_uri,
+                            out_dir=output / "other",
+                            name=artifact.file_info.sha256,
+                            file_uri=artifact.file_info.file_uri,
                         )
 
     if not tasks:

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/utils/scanner/__init__.py

@@ -239,17 +239,13 @@ async def scan_internal(
     ) -> None:
         sandbox_arguments = SandboxArguments(
             type=ScanType.SCAN,
-            sandbox_key_name=key.name.get_secret_value(),
+            sandbox_key_name=key.name,
             sandbox_options=sandbox_options.sandbox,
         )
         save_scan_arguments(out_dir, sandbox_arguments)
-
-        # try:
         await process_file(sandbox_options, file_path, out_dir, idx)
-        # except Exception as ex:
-        #     console.log(f"[cyan]{idx}[/] {file_path} Error: {ex!r}")
 
-    console.info(f"Using key: name={key.name.get_secret_value()} max_workers={key.max_workers}")
+    console.info(f"Using key: name={key.name} max_workers={key.max_workers}")
 
     tasks: list[Coroutine[Any, Any, None]] = []
     sandbox, sandbox_options, images = await _prepare_scan_options(

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/utils/scanner/advanced.py

@@ -78,9 +78,9 @@ async def _get_compiled_rules(progress: Progress, rules_dir: Path | None, is_loc
 
 
 def get_elapsed_time(task: Task) -> str:
-    hours = int(task.elapsed) // 3600
-    minutes = (int(task.elapsed) % 3600) // 60
-    seconds = int(task.elapsed) % 60
+    hours = int(task.elapsed or 0) // 3600
+    minutes = (int(task.elapsed or 0) % 3600) // 60
+    seconds = int(task.elapsed or 0) % 60
     return f"[yellow]{hours}:{minutes:02d}:{seconds:02d}[/]"
 
 
@@ -399,17 +399,13 @@ async def scan_internal_advanced(
     ) -> None:
         sandbox_arguments = SandboxArguments(
             type=ScanType.SCAN_NEW,
-            sandbox_key_name=key.name.get_secret_value(),
+            sandbox_key_name=key.name,
             sandbox_options=sandbox_options,
         )
         save_scan_arguments(out_dir, sandbox_arguments)
-
-        # try:
         await process_file(sandbox_options, file_path, out_dir, idx)
-        # except Exception as ex:
-        #     console.log(f"[cyan]{idx}[/] {file_path} Error: {ex!r}")
 
-    console.info(f"Using key: name={key.name.get_secret_value()} max_workers={key.max_workers}")
+    console.info(f"Using key: name={key.name} max_workers={key.max_workers}")
 
     tasks: list[Coroutine[Any, Any, None]] = []
     with progress:
@@ -454,6 +450,3 @@ async def scan_internal_advanced(
 
         await asyncio.gather(*tasks)
         await sandbox.api.session.close()
-
-    # clear last line
-    sys.stdout.write("\033[F\033[K")

{sandbox_cli-0.2.49 → sandbox_cli-0.2.50}/sandbox_cli/utils/scanner/rescan.py

@@ -246,14 +246,14 @@ async def rescan_internal(
 
         await process_trace(drakvuf_trace, tcpdump_pcap, trace, out_dir, idx)
 
-    console.info(f"Using key: name={key.name.get_secret_value()} max_workers={key.max_workers}")
+    console.info(f"Using key: name={key.name} max_workers={key.max_workers}")
 
     tasks: list[Coroutine[Any, Any, None]] = []
     with progress:
         sandbox, sandbox_options = await _prepare_rescan_options(progress, rules_dir, key, is_local)
         sandbox_arguments = SandboxArguments(
             type=ScanType.RE_SCAN,
-            sandbox_key_name=key.name.get_secret_value(),
+            sandbox_key_name=key.name,
             sandbox_options=sandbox_options.sandbox,
         )