https://github.com/bc-security/report-generation-plugin

Plugin for replacing the original reporting functionality in Empire with customizable PDFs.
https://github.com/bc-security/report-generation-plugin

Last synced: 5 days ago
JSON representation

Plugin for replacing the original reporting functionality in Empire with customizable PDFs.

• Host: GitHub
• URL: https://github.com/bc-security/report-generation-plugin
• Owner: BC-SECURITY
• License: mit
• Created: 2020-07-03T02:28:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-19T05:28:14.000Z (4 months ago)
• Last Synced: 2024-07-19T13:34:30.221Z (4 months ago)
• Language: Python
• Homepage:
• Size: 147 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Advanced Reporting Plugin

The report plugin replaces the original reporting functionality in [Empire](https://github.com/BC-SECURITY/Empire/) with

customizable PDFs and Markdown files. The PDFs use a style.css and Jinja2 template markdown files to generate the PDF reports. The style.css

and markdown files can be customized with personalized logos or other information. The reports use MITRE ATT&CK to generate two tailored reports: Empire Report 

and Module Report. The Empire Report parses out the information about Empire and creates a PDF about the attack techniques 

based on the MITRE ATT&CK framework. The Module Report uses the master log to extract all of the used modules and creates

individual sections based on the modules used. Examples of the reports can be found [here](./templates/README.md).



## Prerequisites

- Empire 5.5+

- MD2PDF

- Tabulate

## Install

To run the plugin, install the following packages with Empire.

```bash

sudo poetry add md2pdf tabulate

```

Then run the following command to add the plugin to Empire.

```bash

cd empire/server/plugins/

git clone https://github.com/BC-SECURITY/Report-Generation-Plugin

```