PDFReportGenerator

Overview

The PDFReportGenerator class creates professionally formatted PDF reports for security audits. It generates a complete audit report including cover page, executive summary, methodology, scanning results, penetration testing findings, risk analysis, and recommendations.

Class Definition

class PDFReportGenerator:
    def __init__(self, host: Host)

host

Host

required

The Host object containing all audit data (IP, ports, vulnerabilities, credentials, etc.)

Attributes

host

Host

The target host object containing audit results

timestamp

str

Timestamp of report generation in format YYYYMMDD_HHMMSS

filename

Path

Output file path: outputs/REPORT_{ip}_{timestamp}.pdf

styles

StyleSheet

ReportLab stylesheet containing all paragraph styles

Color Constants

The following color constants are used throughout the report styling:

DARK_BG = HexColor('#1a1a2e')
ACCENT = HexColor('#e94560')
LIGHT_BG = HexColor('#f5f5f5')
SUCCESS_GREEN = HexColor('#27ae60')
WARNING_ORANGE = HexColor('#f39c12')

DARK_BG

HexColor

Dark background color #1a1a2e - used for headers

ACCENT

HexColor

Accent color #e94560 - used for highlights and dividers

LIGHT_BG

HexColor

Light background color #f5f5f5 - used for alternating table rows

SUCCESS_GREEN

HexColor

Success color #27ae60 - used for positive results

WARNING_ORANGE

HexColor

Warning color #f39c12 - used for warnings

Methods

generate()

Generates the complete PDF report by building all sections and writing to file.

def generate(self):

Returns: None (writes PDF to self.filename) Side Effects:

Creates PDF file in outputs/ directory
Prints confirmation message to stdout

Example:

from models.host import Host
from reporter.pdf_generator import PDFReportGenerator

# Create host with audit data
host = Host(ip="192.168.1.100")
host.ports_open = {
    80: {'state': 'open', 'service': 'http', 'product': 'Apache', 'version': '2.4.41'}
}

# Generate report
generator = PDFReportGenerator(host)
generator.generate()
# Output: 📄 ✅ REPORT GENERADO: outputs/REPORT_192_168_1_100_20260310_143022.pdf

_create_custom_styles()

Creates custom paragraph styles for the report sections.

def _create_custom_styles(self):

Styles Created:

CoverTitle - 24pt centered title for cover page
CoverSubtitle - 14pt centered subtitle
SectionTitle - 16pt section headers
SubSection - 12pt subsection headers
BodyText - 10pt justified body text
AlertCritical - 10pt red text with light red background
AlertSuccess - 10pt green text for positive results

_add_cover_page()

Adds the cover page with audit overview information.

def _add_cover_page(self, story):

story

list

required

ReportLab story list to append elements to

Cover Page Contents:

Report title
Framework version
Target IP address
Operating system detection
Risk level
Analysis date
Summary statistics (open ports, vulnerabilities, credentials)

_add_index()

Adds table of contents listing all report sections.

def _add_index(self, story):

story

list

required

ReportLab story list to append elements to

Sections Listed:

Resumen Ejecutivo
Metodología
Herramientas Utilizadas
Fase de Escaneo (Reconocimiento)
Fase de Penetración: Fuerza Bruta (WordPress)
Fase de Penetración: Inyección SQL (DVWA)
Credenciales Extraídas
Análisis de Riesgo
Recomendaciones de Seguridad
Conclusiones

_add_executive_summary()

Adds executive summary with high-level findings.

def _add_executive_summary(self, story):

story

list

required

ReportLab story list to append elements to

Summary Includes:

Target IP and OS
Total open ports
Total vulnerabilities by severity (critical, high, medium)
Total credentials extracted
Total directories discovered
Overall risk level

_add_methodology()

Adds methodology section describing the audit process.

def _add_methodology(self, story):

story

list

required

ReportLab story list to append elements to

Phases Documented:

Reconnaissance (Nmap, Gobuster)
WordPress Brute Force (WPScan)
SQL Injection (SQLMap)
Risk Analysis
Reporting

_add_tools()

Adds table of tools used during the audit.

def _add_tools(self, story):

story

list

required

ReportLab story list to append elements to

Tools Listed:

Kali Linux
Nmap
SQLMap
WPScan
Gobuster/Dirb
Python 3
ReportLab

_add_scanning_phase()

Adds reconnaissance phase findings (ports, services, directories).

def _add_scanning_phase(self, story):

story

list

required

ReportLab story list to append elements to

Contents:

OS detection results
Open ports table with service versions
Directory enumeration results (up to 20 directories)

_add_bruteforce_phase()

Adds WordPress brute force attack findings.

def _add_bruteforce_phase(self, story):

story

list

required

ReportLab story list to append elements to

Contents:

WPScan enumeration results
Vulnerable plugins detected
Credentials obtained via brute force
Success/failure status

_add_sqli_phase()

Adds SQL injection attack findings against DVWA.

def _add_sqli_phase(self, story):

story

list

required

ReportLab story list to append elements to

Contents:

SQLMap injection process
Database dump results
SQL injection vulnerabilities found
Success/failure status

_add_credentials()

Adds table of all extracted credentials.

def _add_credentials(self, story):

story

list

required

ReportLab story list to append elements to

Table Columns:

Source (WordPress, SQLi, etc.)
Username
Password/Hash
Cracked status (SI/NO)

_add_risk_analysis()

Adds comprehensive risk analysis and vulnerability details.

def _add_risk_analysis(self, story):

story

list

required

ReportLab story list to append elements to

Contents:

Overall risk level
Vulnerability count by severity
Detailed vulnerability list with descriptions
Risk calculation methodology

_add_recommendations()

Adds prioritized security recommendations.

def _add_recommendations(self, story):

story

list

required

ReportLab story list to append elements to

Recommendation Priorities:

CRÍTICA (Critical)
ALTA (High)
MEDIA (Medium)
BAJA (Low)

Example Recommendations:

Update WordPress and plugins
Implement prepared statements
Change compromised passwords
Enable 2FA
Install WAF (ModSecurity)

_add_conclusions()

Adds final conclusions and report metadata.

def _add_conclusions(self, story):

story

list

required

ReportLab story list to append elements to

Contents:

Summary of findings
Risk assessment conclusion
Remediation urgency
Ethical hacking disclaimer
Generation timestamp

Usage Example

from models.host import Host
from models.vulnerability import Vulnerability, RiskLevel
from reporter.pdf_generator import PDFReportGenerator

# Create host object
host = Host(ip="192.168.1.100")
host.os_detection = "Linux 3.x"
host.risk_level = RiskLevel.HIGH

# Add ports
host.ports_open = {
    80: {
        'state': 'open',
        'service': 'http',
        'product': 'Apache httpd',
        'version': '2.4.41'
    },
    3306: {
        'state': 'open',
        'service': 'mysql',
        'product': 'MySQL',
        'version': '5.7.33'
    }
}

# Add vulnerabilities
vuln = Vulnerability(
    name="SQL Injection",
    description="DVWA vulnerable to SQL injection in id parameter",
    risk=RiskLevel.CRITICAL,
    recommendations="Use prepared statements"
)
host.vulnerabilities.append(vuln)

# Add credentials
host.credentials.append({
    'source': 'SQLi - DVWA',
    'user': 'admin',
    'password': 'password123',
    'cracked': True
})

# Generate PDF report
generator = PDFReportGenerator(host)
generator.generate()

# Output file: outputs/REPORT_192_168_1_100_20260310_143022.pdf

Report Structure

The generated PDF contains the following sections in order:

Cover Page - Audit overview and statistics
Index - Table of contents
Executive Summary - High-level findings
Methodology - Audit process description
Tools Used - Software and versions
Scanning Phase - Reconnaissance results
Brute Force Phase - WordPress attack findings
SQL Injection Phase - DVWA attack findings
Credentials Extracted - All compromised credentials
Risk Analysis - Vulnerability assessment
Recommendations - Prioritized remediation steps
Conclusions - Final assessment

Page Layout

Page Size: A4
Margins: 2cm (top, bottom, left, right)
Font: Helvetica family
Color Scheme: Dark navy (#1a1a2e) and red accent (#e94560)

Core

Services

Reporting

Overview

Class Definition

Attributes

Color Constants

Methods

generate()

_create_custom_styles()

_add_cover_page()

_add_index()

_add_executive_summary()

_add_methodology()

_add_tools()

_add_scanning_phase()

_add_bruteforce_phase()

_add_sqli_phase()

_add_credentials()

_add_risk_analysis()

_add_recommendations()

_add_conclusions()

Usage Example

Report Structure

Page Layout

Build docs developers (and LLMs) love

Core

Services

Reporting

​Overview

​Class Definition

​Attributes

​Color Constants

​Methods

​generate()

​_create_custom_styles()

​_add_cover_page()

​_add_index()

​_add_executive_summary()

​_add_methodology()

​_add_tools()

​_add_scanning_phase()

​_add_bruteforce_phase()

​_add_sqli_phase()

​_add_credentials()

​_add_risk_analysis()

​_add_recommendations()

​_add_conclusions()

​Usage Example

​Report Structure

​Page Layout

Build docs developers (and LLMs) love

Overview

Class Definition

Attributes

Color Constants

Methods

generate()

_create_custom_styles()

_add_cover_page()

_add_index()

_add_executive_summary()

_add_methodology()

_add_tools()

_add_scanning_phase()

_add_bruteforce_phase()

_add_sqli_phase()

_add_credentials()

_add_risk_analysis()

_add_recommendations()

_add_conclusions()

Usage Example

Report Structure

Page Layout