mirror of https://github.com/avast/PurpleDome
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
1.8 KiB
ReStructuredText
92 lines
1.8 KiB
ReStructuredText
===
|
|
CLI
|
|
===
|
|
|
|
Three command line tools exists offering a simple interface to PurpleDome.
|
|
|
|
The central one is Experiment control where you start your experiments:
|
|
|
|
.. asciinema:: ./../asciinema/experiment_control.cast
|
|
:speed: 2
|
|
|
|
|
|
|
|
|
|
|
|
Experiment control
|
|
==================
|
|
|
|
Experiment control is the core tool to run an experiment. It accepts a yaml config file and runs the experiments in there. The configuration file defines the system to be used (together with a Vagrant file referenced there) and the attacks to run.
|
|
|
|
.. argparse::
|
|
:filename: ../experiment_control.py
|
|
:func: create_parser
|
|
:prog: ./experiment_control.py
|
|
|
|
|
|
|
|
|
|
|
|
Testing YAML files
|
|
==================
|
|
|
|
Configuration can be a bit complex and mistakes can happen. To find them before you run Purpledome use pydantic_test.py
|
|
|
|
.. argparse::
|
|
:filename: ../pydantic_test.py
|
|
:func: create_parser
|
|
:prog: ./pydantic_test.py
|
|
|
|
|
|
|
|
|
|
|
|
Plugin manager
|
|
==============
|
|
|
|
List available plugins or a specific plugin config. Most importantly: You can verify your plugin using it !
|
|
|
|
.. argparse::
|
|
:filename: ../plugin_manager.py
|
|
:func: create_parser
|
|
:prog: ./plugin_manager.py
|
|
|
|
|
|
|
|
|
|
|
|
Caldera control
|
|
===============
|
|
|
|
Directly control a caldera server. You will need a running caldera server to connect to. This plugin is handy to list available attacks and find the attack IDs matching specific TTP-IDs.
|
|
|
|
.. argparse::
|
|
:filename: ../caldera_control.py
|
|
:func: create_parser
|
|
:prog: ./caldera_control.py
|
|
|
|
|
|
|
|
|
|
|
|
Machine control
|
|
===============
|
|
|
|
Directly control the machines
|
|
|
|
.. argparse::
|
|
:filename: ../machine_control.py
|
|
:func: create_parser
|
|
:prog: ./machine_control.py
|
|
|
|
|
|
|
|
|
|
|
|
Doc generator
|
|
=============
|
|
|
|
.. argparse::
|
|
:filename: ../doc_generator.py
|
|
:func: create_parser
|
|
:prog: ./doc_generator.py |