For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

... or how to install secator and it's dependencies on different platforms.


Installing secator

pipx install secator
pip install secator
bash -c "$(curl -fsSL https://raw.githubusercontent.com/freelabz/secator/main/scripts/install_universal.sh)"

The script accepts optional flags (--version <version>, --addons <list>, --tools [<list>], --templates <path>), for instance:

curl -fsSL https://raw.githubusercontent.com/freelabz/secator/main/scripts/install_universal.sh -o install_secator.sh
bash install_secator.sh --addons worker,mongodb --tools httpx,nuclei
docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator --help

The volume mount -v is necessary to save all secator reports to your host machine, and--net=host is recommended to grant full access to the host network.

You can alias this command to run it easier:

alias secator="docker run -it --rm --net=host -v ~/.secator:/root/.secator freelabz/secator"

Now you can run secator like if it was installed on baremetal:

secator --help
git clone https://github.com/freelabz/secator
cd secator
docker compose up -d
docker compose exec secator secator --help

Installing languages (optional)

secator uses external tools, so you might need to install languages used by those tools assuming they are not already installed on your system.

We provide a subcommand to install required languages if you don't manage them externally:

secator install langs go   # install Go
secator install langs ruby # install Ruby

Installing tools (optional)

secator can install tools automatically at runtime (provided security.auto_install_commands is enabled, which is the default), but you can also do it manually.

We provide a subcommand to install or update each supported tool which should work on all systems supporting apt:

secator install tools httpx  # install httpx
secator install tools        # install all supported tools

Installing addons (optional)

secator comes installed with the minimum amount of dependencies.

We provide a subcommand to install additional addons which are required for various features:

Add support for Celery (see Distributed runs with Celery).

Add support for the Google Drive exporter (see Exporters).

Add support for the Google Cloud Storage driver (see GCS driver).

Add support for MongoDB driver (see MongoDB driver).

Add support for Celery Redis broker / backend.

Add support for the Vulners CVE provider (set addons.vulners.api_key and providers.defaults.cve to vulners).

Add support for the ai task (see AI task).

Add development tools like coverage and flake8 required for running tests.

Add tracing tools like memray and pyinstrument required for tracing functions.

Add the packaging tools needed by secator u build and secator u publish.

The SQLite driver does not need an addon: it uses Python's built-in sqlite3 module.


Updating secator

To update secator to the latest version:


Shell completion (optional)

secator supports shell completion for bash, zsh and fish (task, workflow, scan and profile names, and options such as --workspace, --driver or --output):

Run secator util completion --shell <SHELL> without --install to print the completion script instead.


Checking installation health

To figure out which languages or tools are installed on your system (along with their version):

Secator Health CLI Output

Last updated