Multi-Format Reports

Overview

PortShim generates every deliverable you need from a single command. Findings are rendered with consistent severity colouring, branding, and structured formatting across all formats. No manual copy-paste between tools.

DOCX — Full Report

Branded A4 document suitable for client delivery:

• Cover page with engagement title, date, and classification
• Auto-generated table of contents
• Executive summary with key metrics (hosts scanned, vulnerabilities found, criticals resolved)
• Per-finding sections with CVSS score, vector, description, evidence, and remediation steps
• Calibri font, consistent heading styles, severity-coloured finding badges

Command: python scripts/report-gen.py --format docx

PPTX — Executive Brief

Six-slide deck for stakeholder presentations:

1. Title slide — Engagement name, date, classification
2. Executive summary — Key metrics and overall risk posture
3. Finding overview — Severity breakdown chart (critical/high/medium/low)
4. Top findings — Three most critical vulnerabilities with impact
5. Remediation roadmap — Prioritised fix timeline
6. Next steps — Retest schedule and recommendations

Command: python scripts/report-gen.py --format pptx

PDF — Print-Ready

WeasyPrint-rendered A4 PDF with:

• Inline severity badges (critical=#ef4444, high=#f59e0b, medium=#06b6d4, low=#10b981)
• Cover page and table of contents
• Page numbers and running headers
• Hyperlinked cross-references

Command: python scripts/report-gen.py --format pdf

XLSX — Remediation Checklist

Spreadsheet for tracking remediation progress:

• Auto-coloured severity column (red/amber/blue/green)
• Dropdown filters per column
• Status column: Open / In Progress / Verified / Accepted Risk
• Retest results column for Phase 5
• Printable with frozen header row and print area set

Command: python scripts/excel-checklist.py

Consistent Colour Scheme

All formats use the same severity palette:

• Critical — #ef4444 (red)
• High — #f59e0b (amber)
• Medium — #06b6d4 (cyan)
• Low — #10b981 (green)
• Info — #64748b (slate)

Sample Reports

Preview of each report format, rendered from a synthetic sample assessment: six example findings for reserved hostnames (RFC 2606), with a TEST-NET-1 documentation range (RFC 5737) printed as the scan's network — the hosts are names, and no host address falls in that range. Run the pipeline on your own findings to produce the same formats: they are written under outputs/reports/.