Secator docs
  • GETTING STARTED
    • Introduction
    • Installation
    • CLI Usage
    • Library usage
    • Configuration
    • Examples
      • 5 minutes secator session
  • MORE OPTIONS
    • Global options
    • Meta options
    • Input formats
    • Output options
  • IN-DEPTH
    • Philosophy & design
    • Distributed runs with Celery
    • Concepts
      • Output types
      • Proxies
      • Exporters
      • Runners
      • Drivers
      • Profiles [WIP]
    • Deployment
  • For developers
    • Development setup
    • Writing tasks
      • Integrating an external command
        • Parsing JSON lines
        • Parsing raw standard output
        • Parsing output files
        • Example: integrating ls
        • Example: cat hunters
      • Integrate custom Python code [WIP]
      • Advanced options
    • Writing workflows
    • Writing scans [WIP]
Powered by GitBook
On this page
  • Installing secator
  • Installing languages
  • Installing tools
  • Installing addons
  • Installing CVEs
  • Checking installation health

Was this helpful?

  1. GETTING STARTED

Installation

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

Installing secator

pipx install secator
pip install secator
wget -O - https://raw.githubusercontent.com/freelabz/secator/main/scripts/install.sh | sh
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

If you chose the Bash, Docker, or Docker Compose installation methods, you can jump straight to CLI Usage.

Installing languages

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

secator does not install any of the external tools it supports by default.

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

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).

secator install addons worker

Add support for Google Drive exporter (see Exporters).

secator install addons google
secator install addons mongodb

Add support for Celery Redis broker / backend.

secator install addons redis

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

secator install addons dev

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

secator install addons trace

Installing CVEs

We provide a subcommand to download all known CVEs locally so that future lookups are made from disk instead:

secator install cves

This step can take a while as all CVEs will be download and extracted to disk.

Checking installation health

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

secator health
PreviousIntroductionNextCLI Usage

Last updated 7 months ago

Was this helpful?

Add support for MongoDB driver (see ).

secator makes remote API calls to to get in-depth information about the CVEs it encounters.

https://cve.circl.lu/
Secator Health CLI output
MongoDB driver