Feature: Generate a Formatted Report (PDF/Markdown)

[Aaditya-G]

Instead of just outputting the raw text of the predicted system prompt, add a feature to generate a structured report. The report could include the target endpoint, the prompts sent, the responses received, and the final inferred system prompt. This would be very useful for security auditors.

[RHL-RWT-01]

Hi @Aaditya-G could you please assign this issue to me? I’d like to work on adding the structured report feature. Thank you!

[Aaditya-G]

@RHL-RWT-01 can you please come up with your approach, thanks.

[RHL-RWT-01]

Hi @Aaditya-G, thanks for the opportunity. Here's my approach:

Approach

Report Structure

Create a structured audit report containing:

• Executive Summary: Timestamp, target endpoint, detection status
• Target Information: Endpoint URL, API config, model details
• Detection Process: All prompts sent + responses received with timestamps
• Analysis Results: Inferred system prompt

Implementation Plan

1. Data Collection Layer

   • Create a ReportData class to capture prompts, responses, and metadata during detection
   • Modify existing detection flow to log all relevant information

2. Report Generation Module

   • Implement ReportGenerator with pluggable formatters
   • Markdown formatter (no dependencies, lightweight)
   • PDF formatter (using weasyprint or reportlab)

3. CLI Integration

   • Add flags: --report-format [markdown|pdf|both], --output-file <path>
   • Keep backward compatibility with existing CLI

Happy to start working on this once assigned

[RHL-RWT-01]

Hi @Aaditya-G, since I am working on this, I'd like to work on issue 16 as well.

[Aaditya-G]

@RHL-RWT-01 let's get done with this first.

[LifeHashed]

@RHL-RWT-01 are you still working on this. If not, I would like to take up this issue if permitted by the maintainers