Skip to content

Welcome to Aphids Documentation

Here can be found all of the documentation necessary to run the Aphids application. We hope you like it! This is still in active development and new features are planned as part of the road map.

Aphids at runtime

What is it?

This is a command line utility designed to act as a scriptable wrapper for Pentest and Application Security related tools. Aphids is a dockerized to maintain stabiltiy and functionality. There is no need for the tools to be on your system or configured for this to run, you just need docker.

How do I get it?

See the Quick Start guide for how to get and do an initial run of the docker container. Have all the dependencies covered and just want to get started?

  • Get Docker Container

docker pull ghcr.io/darksidesecurity/aphids:latest

  • Install aphids-cli with pip

pip install git+https://github.com/darksidesecurity/aphids.git

  • Run with options.yaml and config.yaml

aphids-cli -o options.yaml -c config.yaml

Dependencies

  • Python 3 or Higher is recommended for using the aphids-cli.
  • Docker for aphids-core

The docker container can be invoked directly, or you can use the aphids-cli wrapper for a more enjoyable user experience.

Hive Integration

This CLI tool is meant to be used with the Hive. An offensive SaaS platform built to correlate and provide extensible functionality to the CLI. With the Hive you can:

  • Manage your Offensive Operations.
  • Create Engagements for your CLI scans.
  • Create Relationships between asset data and operational data.
  • Use asset data from Aphids to create vulnerability reports.
  • Recursive AI Driven Scanning by extending Aphid's functionality.