Penetration Test Report Generator
Tool for generating penetration reports in PDF and HTML from Markdown.
Table of Contents
Simplifying penetration test reports with Markdown
Writing penetration test reports is time-consuming and demands accuracy and attention to detail. Fortunately, using plaintext markdown files makes this process much simpler and more efficient. Markdown files allow for collaboration through Git, while the straightforward syntax lets you focus on your content without worrying about styling. This eliminates issues such as misplaced formatting or styling tables by hand, enabling you to produce a clear and concise report that effectively communicates your findings and recommendations.
Key features
pentest-report-generator is a Python tool for generating penetration test reports. It offers the ability to create reports in both PDF and HTML formats. It can be installed from PyPi or used within Docker. Some of its notable features include:
- Automatic ordering of vulnerabilities by severity
- Color-coded tables for easy readability
- Source code snippets are highlighted for improved readability
- Customizable report template written in HTML and CSS
- Clickable links across the document
How it works
The core of the project involves generating printable PDF documents from HTML. The HTML is created from Markdown files. You can use HTML inside the markdown files, and all pages can be written in HTML too.
Get started with pentest-report-generator
If you’re interested in using pentest-report-generator, check out the GitLab repository for an example penetration test report, setup instructions, and more.
Screenshots
Below are a few screenshots from the example penetration test report. You can see the whole report on GitLab.
The table of contents is generated automatically. Vulnerabilities are ordered by their severity, and appendixes are ordered by filename.
The methodology is not part of the core template, so that it can be modified easily. The methodology is sourced from an HTML file to allow that nice table with colors.
Finally, appendixes are supported. Notice the code highlighting and links.
Table of Contents
Methodology Page
Page with Vulnerability Finding
Appendix