|
1 | 1 | # MITRE Caldera Plugin: Debrief |
2 | 2 |
|
3 | | -A Caldera plugin: https://github.com/mitre/caldera |
| 3 | +A plugin for [MITRE Caldera](https://github.com/mitre/caldera) |
4 | 4 |
|
5 | 5 | Debrief is a plugin for gathering overall campaign information and analytics for |
6 | 6 | operations. It provides a centralized view of operation metadata, network topology |
@@ -33,9 +33,77 @@ tactics & techniques with ATT&CK v18 detection strategy mapping, and step output |
33 | 33 | - **ATT&CK v18 Detection Mapping** — Maps operation techniques to MITRE ATT&CK v18 detection strategies and analytics |
34 | 34 | - **Dark Theme UI** — Styled tables and cards matching Caldera's purple theme |
35 | 35 |
|
36 | | -## Legacy Views |
| 36 | +## Installation |
37 | 37 |
|
38 | | - |
39 | | - |
| 38 | +### As a Caldera Submodule (Recommended) |
40 | 39 |
|
41 | | -Example generated PDF: [Caldera Debrief Report](docs/Demo-Operation_Debrief_Example.pdf) |
| 40 | +Clone Caldera with the debrief plugin included: |
| 41 | + |
| 42 | +```bash |
| 43 | +git clone https://github.com/mitre/caldera.git --recursive |
| 44 | +``` |
| 45 | + |
| 46 | +If Caldera is already cloned, add debrief as a plugin: |
| 47 | + |
| 48 | +```bash |
| 49 | +cd caldera/plugins |
| 50 | +git clone https://github.com/mitre/debrief.git |
| 51 | +``` |
| 52 | + |
| 53 | +### Enable the Plugin |
| 54 | + |
| 55 | +Add `debrief` to the list of enabled plugins in your Caldera configuration file (`conf/local.yml` or `conf/default.yml`): |
| 56 | + |
| 57 | +```yaml |
| 58 | +plugins: |
| 59 | + - debrief |
| 60 | +``` |
| 61 | +
|
| 62 | +### Install Python Dependencies |
| 63 | +
|
| 64 | +From your Caldera virtual environment: |
| 65 | +
|
| 66 | +```bash |
| 67 | +pip install reportlab svglib lxml aiohttp-jinja2 |
| 68 | +``` |
| 69 | + |
| 70 | +### Build the Vue UI |
| 71 | + |
| 72 | +Debrief uses the Magma Vue.js framework. Rebuild Magma to include the debrief plugin UI: |
| 73 | + |
| 74 | +```bash |
| 75 | +cd caldera/plugins/magma |
| 76 | +npm install |
| 77 | +npm run build |
| 78 | +``` |
| 79 | + |
| 80 | +Or start Caldera with the `--build` flag: |
| 81 | + |
| 82 | +```bash |
| 83 | +python server.py --insecure --build |
| 84 | +``` |
| 85 | + |
| 86 | +> **Note:** Requires Node.js >= 20.19 or >= 22.12 for Vite 7. |
| 87 | +
|
| 88 | +### Start Caldera |
| 89 | + |
| 90 | +```bash |
| 91 | +cd caldera |
| 92 | +python server.py --insecure |
| 93 | +``` |
| 94 | + |
| 95 | +Navigate to the Caldera UI and click on the **debrief** plugin in the sidebar. |
| 96 | + |
| 97 | +## Running Tests |
| 98 | + |
| 99 | +```bash |
| 100 | +cd caldera/plugins/debrief |
| 101 | +pip install pytest pytest-asyncio |
| 102 | +python -m pytest tests/ -v |
| 103 | +``` |
| 104 | + |
| 105 | +## Configuration |
| 106 | + |
| 107 | +Plugin configuration options can be set in `plugins/debrief/conf/default.yml`: |
| 108 | + |
| 109 | +- `reportlab_trusted_hosts` — List of trusted hosts for ReportLab SVG rendering (optional) |
0 commit comments