Drivers

... or how to route live results to a destination.

A driver is a set of hooks that constitute a full integration to route live results to certain destination.

Unlike hooks, you can use a driver from the CLI by using the -driver option.


MongoDB driver

To export live results to MongoDB database:

secator install addons mongodb
secator config set addons.mongodb.url mongodb://localhost
secator w host_recon example.com -driver mongodb

Results will be added to the database in real-time as results come through from the various tools supported by secator.

A MongoDB collection is created for each Output types supported by secator.


GCS driver

To upload files (screenshots and stored responses) from URL results to Google Cloud Storage:

secator install addons gcs
secator config set addons.gcs.bucket_name my-bucket-name
secator w host_recon example.com -driver gcs

Files will be uploaded to Google Cloud Storage in real-time as results come through. The local file paths (screenshot_path, stored_response_path) in URL results will be replaced with GCS URLs (gs://bucket-name/blob-name).

circle-info

Authentication: The GCS driver uses the Google Cloud Storage client library which automatically detects credentials. You can authenticate using one of the following methods:

  • Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to your credentials JSON file

  • Use Application Default Credentials if running on Google Cloud Platform

  • The client library will automatically detect credentials from your environment

The addons.gcs.credentials_path config option is available but optional, as the client library handles credential detection automatically.


Last updated

Was this helpful?