Reporting: Markdown summary reports

Description

Generate Markdown-formatted summary reports for easy integration with documentation, wikis, and version control.

Report Contents

1. Header with Metadata

   • Report title and date
   • Target domain/IP
   • Scan duration
   • Framework version

2. Executive Summary

   • Risk assessment
   • Critical findings
   • Key recommendations

3. Findings by Category

   • Domain Controller Security
   • Email Service Configuration
   • SMB Share Permissions
   • ADCS Certificate Issues
   • Kerberos Weaknesses
   • Credential Issues

4. Detailed Findings

   • Unique finding per section
   • Description
   • Impact
   • Remediation steps
   • References/CVEs

5. Appendix

   • Tools executed
   • Timeline
   • Methodology
   • Assumptions and limitations

Features

• GitHub-flavored Markdown
• Table of contents
• Code blocks for technical details
• Links to resources
• CVSS scoring
• Custom header/footer support

Files to Create

• adpentest/exporters/markdown_exporter.py
• templates/report.md.jinja2

Implementation

• Pure Python string formatting
• Optional: Markdown validation
• Support for custom templates

Success Criteria

• All findings included
• Proper Markdown formatting
• Table of contents auto-generated
• Integrates with GitHub/GitLab wikis
• Clean rendering without external tools

Start by inspecting the existing report and finding data structures before creating adpentest/exporters/markdown_exporter.py and templates/report.md.jinja2. Verify how findings, metadata, CVSS scores, tools, and timeline data are exposed. Done means the generated GitHub-flavored Markdown includes all listed sections, an automatic table of contents, custom template support, and clean rendering without external tools.