Configuration

The utility is configured via a toml file.

Note

If no sandbox is specified, the functions related to interacting with the sandbox will be unavailable.

Location

Linux / MacOSWindows

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

%APPDATA%\sandbox-cli\config.toml

Config

passwords

There is often a need to scan various password-protected zip archives.

Here you can specify a list of frequently used passwords that the sandbox-cli will send to the sandbox for automatic unpacking.

Default: ["infected"]

sandbox

Option	Description	Default
name*	Custom token name to be used in the parameters when selecting sandboxes.	None
key *	A token received through the sandbox interface. See how to get it in Getting started.	None
host *	The IP address or domain where the sandbox is located. Example: 10.10.10.10 or sandbox.example.com	None
max-workers	The number of simultaneously running jobs.	8

Note

If you specify a higher number of max-workers, the performance will not increase, the tasks will just hang in the queue.

ssh

Option	Description	Default
login	The user's login on the server	None
password	The user's password on the server	None

browser

Here you can specify custom browser to use for opening the analysis links.

Option	Description	Default
path	Path to custom browser	None
args	Args to start the browser with	None

Note

Every argument must be in separate string.

Full configuration

Config example

# passwords that will be sent to the sandbox for unpacking archives
passwords = ["infected"]

# Use this section only if you don't want to use your default browser
# or it works incorrectly
# [browser]
# path to your browser
# path = "C:\\Program Files\\Mozilla Firefox\\firefox.exe"
# args to run your browser with
# args = ["-new-tab"]

# Specify available sandboxes
# Keep in mind that first sandbox is used by default
# name - short name for the sandbox
# key - token used for the sandbox
# host - host of the sandbox
# max-workers - simultaneously running scans
# ssh username/password - optional params
[[sandbox]]
name = ""
key = ""
host = ""
max-workers = 8
ssh = { username = "", password = "" }

[[sandbox]]
name = ""
key = ""
host = ""
max-workers = 8