report

rfswift report

Generate structured assessment reports from container sessions.

Synopsis

# Generate a Markdown report (default)
rfswift report generate -c CONTAINER

# Generate an HTML report
rfswift report generate -c CONTAINER --format html

# Generate a PDF report (requires pandoc or wkhtmltopdf)
rfswift report generate -c CONTAINER --format pdf

# Custom title and output path
rfswift report generate -c CONTAINER --title "Assessment Report" -o report.html -f html

The report command collects data from a container and its workspace, then generates a structured document combining container metadata, session recordings, shell history, and workspace artifacts.

This is designed for professional pentesters writing client deliverables, researchers documenting experiments, and educators creating lab reports.

Subcommands

report generate

Collect data from a container and generate a report.

Options:

When -c is omitted in an interactive terminal, a container picker is shown.

Report Contents

Each generated report contains the following sections:

1. Container Summary

2. Environment Configuration

Full container configuration: network mode, privileged mode, device mappings, Linux capabilities, cgroup rules, ulimits, and volume bindings.

3. Session Recordings

Inventories all .cast (asciinema) and rfswift-*.log (script) files found in the workspace directory and current working directory. Includes file size and date.

4. Shell History

Extracted from the container’s /root/.bash_history or /root/.zsh_history. Shows all commands run inside the container during the assessment.

5. Workspace Artifacts

Full file inventory of the workspace directory with smart categorization:

6. Notes Section

An editable section for assessor findings, observations, and conclusions.

Output Formats

rfswift report generate -c my_sdr
# → rfswift-report-my_sdr-20260317-143022.md

rfswift report generate -c my_sdr --format html
# → rfswift-report-my_sdr-20260317-143022.html

rfswift report generate -c my_sdr --format pdf -o assessment.pdf

# Install pandoc (recommended)
sudo apt install pandoc      # Debian/Ubuntu
brew install pandoc           # macOS
sudo dnf install pandoc       # Fedora

# Alternative: wkhtmltopdf
sudo apt install wkhtmltopdf

Examples

Basic Assessment Report

# Run an SDR assessment
rfswift run -i penthertz/rfswift_noble:sdr_full -n hackrf_assessment --record

# ... do your work inside the container ...
# hackrf_info
# rtl_433 -f 433.92M -s 2M > /workspace/captures/433mhz.iq
# exit

# Generate the report
rfswift report generate -c hackrf_assessment --format html -o hackrf-report.html

Report with Custom Title

rfswift report generate -c client_pentest \
  --title "Wireless Security Assessment — Client X — March 2026" \
  --format pdf \
  -o client-x-wireless-assessment.pdf

Interactive Mode

# No flags — picks container from a list, generates Markdown
rfswift report generate

Typical Professional Workflow

# 1. Create container with workspace and recording
rfswift run -i penthertz/rfswift_noble:sdr_full -n pentest_wifi --record

# 2. All captures go to ~/rfswift-workspace/pentest_wifi/
#    Inside the container, /workspace is the shared directory
cd /workspace
mkdir captures logs
airodump-ng wlan0 -w captures/scan
# ... assessment work ...

# 3. Generate report with all artifacts
rfswift report generate -c pentest_wifi \
  --title "Wi-Fi Penetration Test — Site Alpha" \
  --format html

# 4. Report includes:
#    - Container config (image, caps, devices)
#    - Session recording from --record
#    - Shell history (all commands you ran)
#    - Workspace files (captures/scan-01.cap, etc.)

How It Works

  graph TD
    A[rfswift report generate -c my_sdr] --> B[Inspect Container]
    B --> C[Container Metadata]
    B --> D[Volume Bindings]
    D --> E[Find Workspace Path]
    E --> F[Scan Recordings]
    E --> G[Inventory Artifacts]
    A --> H[Extract Shell History]
    C --> I[Build Report]
    F --> I
    G --> I
    H --> I
    I --> J{Format?}
    J -->|markdown| K[.md file]
    J -->|html| L[.html file]
    J -->|pdf| M[pandoc/wkhtmltopdf → .pdf]

The report generator:

1. Inspects the container via Docker/Podman API for metadata and configuration
2. Finds the workspace by looking for the /workspace mount in the container’s volume bindings
3. Scans for recordings (.cast files) in the workspace and current directory
4. Extracts shell history from the container’s ~/.bash_history or ~/.zsh_history via docker cp
5. Inventories workspace files with smart categorization based on file extensions
6. Renders the report using Go templates (Markdown or HTML), optionally converting to PDF

Related Commands

• run - Create containers (use --record to capture sessions)
• log - Record and replay terminal sessions
• bindings - Manage volume and device bindings
• exec - Enter containers (use --record to capture sessions)