Report Generation

Create professional security reports for clients. --- Professional format for clients: bash blocksecops export SCANID --format pdf > audit-report.pdf Includes:...

Last updated: January 14, 2026

Report Generation

Create professional security reports for clients.

Export Options

PDF Report

Professional format for clients:

blocksecops export SCAN_ID --format pdf > audit-report.pdf

Includes:

  • Executive summary
  • Findings summary
  • Detailed findings
  • Remediation guidance

JSON Export

Machine-readable format:

blocksecops export SCAN_ID --format json > findings.json

For:

  • Integration with other tools
  • Custom report generation
  • Data analysis

SARIF Export

For GitHub integration:

blocksecops export SCAN_ID --format sarif > results.sarif

CSV Export

For spreadsheets:

blocksecops export SCAN_ID --format csv > findings.csv

Report Sections

1. Executive Summary

For non-technical stakeholders:

  • Overall risk assessment
  • Key findings count
  • Critical issues highlight
  • Recommendations summary

2. Scope and Methodology

Document what was reviewed:

  • Files in scope
  • Commit hash
  • Scan date
  • Scanners used

3. Findings Summary

Overview table:

Severity Count Status
Critical 0 -
High 2 Open
Medium 5 3 Fixed
Low 8 5 Acknowledged

4. Detailed Findings

For each finding:

  • Title and ID
  • Severity
  • Location
  • Description
  • Impact
  • Recommendation
  • Status

5. Appendix

Additional information:

  • Scanner details
  • Full code references
  • Remediation resources

Customizing Reports

Via Dashboard

  1. Go to scan results
  2. Click Export → PDF
  3. Configure options:
    • Include/exclude sections
    • Filter by severity
    • Add custom header
  4. Generate

Custom Branding (Enterprise)

Add your branding:

  • Company logo
  • Custom header/footer
  • Color scheme
  • Contact information

Report Templates

Standard Audit Report

# Security Audit Report

**Client**: [Client Name]
**Contract**: [Contract Name]
**Date**: [Date]
**Auditors**: [Names]

## Executive Summary

[Summary paragraph]

### Risk Rating

Overall Risk: [Low/Medium/High/Critical]

### Finding Summary

| Severity | Count |
|----------|-------|
| Critical | X |
| High | X |
| Medium | X |
| Low | X |

## Scope

### Files Reviewed

- Contract.sol
- Token.sol

### Commit

`abc123def456`

### Methodology

- Automated analysis with BlockSecOps
- Manual code review
- ...

## Findings

### [H-01] Finding Title

**Severity**: High
**Status**: Open

**Location**: `Contract.sol:45`

**Description**:
[Detailed description]

**Impact**:
[Impact description]

**Recommendation**:
[How to fix]


---


## Appendix

### Scanners Used

- Slither v0.10.0
- Mythril v0.24.0
- ...

Workflow Integration

During Audit

Keep findings updated:

  • Add investigation notes
  • Update status as you go
  • Include remediation guidance

Before Export

Quality check:

  1. All findings reviewed
  2. Severities accurate
  3. Status current
  4. Notes complete

After Export

Customize final report:

  1. Add executive summary
  2. Include client-specific context
  3. Add cover page
  4. Final review

API Export

Get Findings

curl -X GET "https://api.blocksecops.com/api/v1/scans/{scan_id}/results" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o results.json

Export PDF

curl -X GET "https://api.blocksecops.com/api/v1/scans/{scan_id}/export?format=pdf" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -o report.pdf

Custom Template

curl -X POST "https://api.blocksecops.com/api/v1/scans/{scan_id}/export" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "pdf",
    "template": "custom",
    "options": {
      "include_low": false,
      "include_informational": false,
      "executive_summary": "Custom summary text..."
    }
  }' \
  -o custom-report.pdf

Best Practices

1. Consistent Format

Use same format across engagements:

  • Professional appearance
  • Easy comparison
  • Client familiarity

2. Clear Severity

Make severity obvious:

  • Color coding
  • Clear labels
  • Consistent criteria

3. Actionable Recommendations

For each finding:

  • Specific fix suggestion
  • Code example when helpful
  • Reference to best practices

4. Executive Summary

Tailor for audience:

  • Non-technical overview
  • Business impact focus
  • Key recommendations

5. Timely Delivery

Set expectations:

  • Draft report: X days after audit
  • Final report: Y days after fixes

Client Handoff

Report Delivery

Include:

  1. PDF report
  2. JSON findings (if requested)
  3. Scope confirmation
  4. Re-verification process

Follow-up

After delivery:

  1. Schedule review call
  2. Answer questions
  3. Clarify findings
  4. Agree on fix timeline

Re-verification

After fixes:

  1. Client submits fixed code
  2. Re-scan with Standard preset
  3. Update finding status
  4. Generate final report

Next Steps