Skip to content

Repository files navigation

🛡️ PenTest Report Generator

Open-source, customizable penetration test report generator with multi-language support.

License Python FastAPI


🌟 Features

  • 🎨 Full Customization: Custom colors, fonts, logos, and branding
  • 🌍 Multi-language: Turkish & English support
  • 📊 CVSS Calculator: Built-in CVSS v3.1 score calculator
  • 📄 Multiple Export Formats: PDF, Markdown, Word (DOCX)
  • 🌙 Dark/Light Theme: Eye-friendly themes
  • 📋 CVE Templates: Pre-defined vulnerability templates
  • 💾 Report History: Local storage for past reports
  • 🎯 5 Preset Themes: Dark, Cyber, Blood, Matrix, Corporate

🚀 Quick Start

Option 1: Docker (Recommended)

# Clone the repository
git clone https://github.com/zer0bav/pentest-report-generator.git
cd pentest-report-generator

# Start with Docker Compose
docker-compose up -d

# Access at http://localhost:8000

Option 2: Manual Installation

# Clone the repository
git clone https://github.com/zer0bav/pentest-report-generator.git
cd pentest-report-generator

# Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/Mac
# or
venv\Scripts\activate  # Windows

# Install dependencies
pip install -r requirements.txt

# Run the application
python -m uvicorn api.main:app --reload

# Access at http://localhost:8000

📁 Project Structure

pentest-report-generator/
├── api/
│   └── main.py          # FastAPI backend
├── static/
│   ├── css/
│   │   └── style.css    # Main styles
│   └── js/
│       ├── app.js       # Main application
│       ├── cvss.js      # CVSS calculator
│       └── translations.js  # i18n
├── templates/
│   └── index.html       # Main HTML template
├── uploads/             # Uploaded logos & exports
├── requirements.txt
├── Dockerfile
├── docker-compose.yml
└── README.md

🎨 Customization Options

Color Palette

  • Primary Color (Background)
  • Secondary Color (Cards)
  • Accent Color (Highlights)
  • Text Color

Preset Themes

Theme Description
⬛ Dark Classic dark theme
🟦 Cyber Blue cybersecurity theme
🟥 Blood Red aggressive theme
🟩 Matrix Green hacker theme
⬜ Corporate Light professional theme

Fonts

  • Inter (Default)
  • Roboto
  • Open Sans
  • JetBrains Mono
  • Arial

📊 CVSS Calculator

Built-in CVSS v3.1 calculator with all metrics:

  • Attack Vector (AV): Network, Adjacent, Local, Physical
  • Attack Complexity (AC): Low, High
  • Privileges Required (PR): None, Low, High
  • User Interaction (UI): None, Required
  • Scope (S): Unchanged, Changed
  • Confidentiality (C): None, Low, High
  • Integrity (I): None, Low, High
  • Availability (A): None, Low, High

📄 Export Formats

PDF

Professional PDF report with custom styling, logos, and branding.

Markdown

Clean markdown format for documentation and Git repositories.

Word (DOCX)

Microsoft Word format for enterprise environments.


🌍 Languages

Language Code Status
Türkçe TR ✅ Full
English EN ✅ Full

📋 Pre-defined CVE Templates

  • CVE-2024-21413 - Microsoft Outlook RCE (MonikerLink)
  • CVE-2024-3400 - Palo Alto PAN-OS Command Injection
  • CVE-2023-44487 - HTTP/2 Rapid Reset (DDoS)
  • CVE-2024-1709 - ConnectWise ScreenConnect Auth Bypass
  • CVE-2024-27198 - JetBrains TeamCity Auth Bypass

🔧 API Endpoints

Endpoint Method Description
/ GET Main application
/api/translations/{lang} GET Get translations
/api/cve-templates GET List CVE templates
/api/cve-template/{cve_id} GET Get specific template
/api/upload-logo POST Upload company logo
/api/generate-report POST Generate HTML report
/api/export/pdf POST Export as PDF
/api/export/markdown POST Export as Markdown
/api/export/docx POST Export as Word

🤝 Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.


🙏 Acknowledgments


Made with ❤️ for the Security Community

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages