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.48.tar.gz (35.4 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.48-py3-none-any.whl (49.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sandbox_cli-0.2.48.tar.gz
Algorithm Hash digest
SHA256 e13e47156d034d0cd6d1387f6d263567a7dc0caeae49a03c0e786569181c980c
MD5 8b606f6d0d3c9cff0c403c653113e733
BLAKE2b-256 1002d927b3f62f8c9ad309662d4031ee657d04222fd6c2bc8ae63e67d380b4fd

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sandbox_cli-0.2.48-py3-none-any.whl
Algorithm Hash digest
SHA256 24ce1c13924598824a13ec009de3e7f9287cb8455012ec17e0eff0ce0791140f
MD5 44165799b90b4be785bccc3540e762cb
BLAKE2b-256 edf90e4dc32b80fb5ab465379e67201c5947c5aee6232e03fa9bbee7c0482f3e

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