Skip to content

readme #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ahenao4 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

readme #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
# MITRE Caldera Plugin: Debrief

A Caldera plugin: https://github.com/mitre/caldera
## Overview:

Debrief is a plugin for gathering overall campaign information and analytics for a selected set of
operations. It provides a centralized view of operation metadata, graphical displays of the operations,
the techniques and tactics used, and the facts discovered by the operations. The plugin additionally
supports the export of campaign information and analytics in PDF format.
The Debrief plugin provides post-operation insights and reporting. This plugin does so by gathering overall campaign information and analytics for a selected set of operations. It then provides a centralized view of operation metadata, graphical displays of the operations, the techniques and tactics used, and the facts discovered by the operations. The plugin additionally supports the export of campaign information and analytics in PDF format.

Example generated PDF: [Caldera Debrief Report](docs/debrief_2023-02-24_17-08-14.pdf)
### Context:
Reporting / post-execution analysis

<!-- ### Known Limitations: -->


## Installation:

This is a core CALDERA plugin and is loaded by default via the plugin loader. Ensure it is present in the `plugins/` directory and listed as enabled in your active configuration file (e.g., `conf/default.yml`).

## Dependencies/Requirements:

No additional dependencies are required beyond a standard CALDERA installation.

## Getting Started:

Here is an example of the generated PDF: [Caldera Debrief Report](docs/debrief_2023-02-24_17-08-14.pdf)

![plugin home](docs/debrief1.png)
![plugin home](docs/debrief2.png)
Expand Down