opnDossier

Readable reports from OPNsense configs. Turns OPNsense config.xml files into clear, operator-ready documentation with optional audit reporting.

Status: Active

opnDossier turns OPNsense config.xml files into clear, operator-ready documentation with optional audit reporting. It parses the XML locally and emits structured Markdown, JSON, or YAML, with terminal rendering and template-driven reports.

Modes and Capabilities

  • Convert: structured Markdown/JSON/YAML (summary or comprehensive)
  • Display: themed terminal rendering with syntax highlighting
  • Audit: standard/blue/red reports with findings, recommendations, and pivot data
  • Plugin-driven compliance checks with extensible templates
  • Offline-only; static Go binary; robust input validation

Usage

Convert to file:

opndossier convert config.xml --format markdown --out report.md
# or JSON/YAML
opndossier convert config.xml --format json --out config.json

Display in terminal:

opndossier display config.xml --style summary --theme dark

Audit modes:

# Standard (neutral)
opndossier audit config.xml --mode standard --out audit.md
# Blue (defensive)
opndossier audit config.xml --mode blue --out audit.md
# Red (attack surface)
opndossier audit config.xml --mode red --out audit.md

Key Features

Multiple Output Formats

Generate reports in Markdown, JSON, or YAML formats for different use cases.

Terminal Rendering

Display configuration information directly in the terminal with syntax highlighting.

Audit Capabilities

Generate security-focused audit reports with different perspectives (standard, blue team, red team).

Plugin Architecture

Extensible framework for adding custom compliance checks and reporting templates.

Ready to Get Started?

Download opnDossier and start using it in your environment.