Skip to main content

Command line tool for interaction with sandboxes

Project description

Image

Work with PT Sandbox like a pro


Documentation: https://security-experts-community.github.io/sandbox-cli

Source Code: https://github.com/Security-Experts-Community/sandbox-cli


[!NOTE] python >= 3.11 is required.

Installation

Using pipx:

pipx install sandbox-cli

Using PyPi:

pip install sandbox-cli

NixOS:

nix shell 'github:Security-Experts-Community/sandbox-cli'

Config

You must create default config file as described in docs/config-examples/config.toml:

Linux/MacOS:

~/.config/sandbox-cli/config.toml
or
$XDG_HOME_CONFIG_HOME/sandbox-cli/config.toml

Windows:

%APPDATA%\sandbox-cli\config.toml

Available options

  • scanner - Scan with the sandbox.
  • images - Get available images in the sandbox.
  • download - Download any artifact from the sandbox.
  • email - Upload an email and get its headers.
  • report - Generate short report from sandbox scans.
  • unpack/conv - Convert sandbox logs into an analysis-friendly format.
  • rules - Working with raw sandbox rules.

Usage examples

images

Get all availables images:

sandbox-cli images
┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
┃ Name                   ID                       Version     Product version ┃
┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩
│ altlinux               altworkstation-10-x64    ...         ...             │
│ astra                  astralinux-smolensk-x64  ...         ...             │
│ redos                  redos-murom-x64          ...         ...             │
│ ubuntu                 ubuntu-jammy-x64         ...         ...             │
│ Windows 10 Pro         win10-1803-x64           ...         ...             │
│ Windows 10 Enterprise  win10-22H2-x64           ...         ...             │
│ Windows 10 Pro         win11-23H2-x64           ...         ...             │
│ Windows 7 Enterprise   win7-sp1-x64             ...         ...             │
│ Windows 7 Enterprise   win7-sp1-x64-ics         ...         ...             │
└───────────────────────┴─────────────────────────┴────────────┴─────────────────┘

scanner

Scan the file on all available windows images with timeout 60s and with automatic logs unpacking:

sandbox-cli scanner scan-new -i windows -t 60 -U malware.exe

Development

uv is used to build the project.

uv sync

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sandbox_cli-0.2.46.tar.gz (35.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sandbox_cli-0.2.46-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

Details for the file sandbox_cli-0.2.46.tar.gz.

File metadata

  • Download URL: sandbox_cli-0.2.46.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for sandbox_cli-0.2.46.tar.gz
Algorithm Hash digest
SHA256 2017220b8eeac8356d8c991b8517204c0fda32d74c8cdfdf6d2f3a34e28c7a0b
MD5 1fbf6d8e69d82ce0f0b92e46b1fdf032
BLAKE2b-256 4f9e59e51919455eb2aedfae71f8c0d3f9fb8382fad40d6252dbd2a4782a5529

See more details on using hashes here.

File details

Details for the file sandbox_cli-0.2.46-py3-none-any.whl.

File metadata

  • Download URL: sandbox_cli-0.2.46-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for sandbox_cli-0.2.46-py3-none-any.whl
Algorithm Hash digest
SHA256 e82e5912f4f584d76a884b7dd0a771ac3102fedecd0968bc92f00c3b2cc1ce7f
MD5 54994c82f526d66acb45c5fcc66777c9
BLAKE2b-256 2216c9c8157cad5521f0394c2b5449ab15cea55ebaea31e8ad629106832497cc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page