Skip to main content

Report Builder

The Report Builder generates professional security assessment reports from your workspace data. Reports are scoped to individual networks and include vulnerability summaries, severity distributions, affected hosts, and detailed findings with proof of exploitation. Output is a downloadable DOCX file that can be customized with your branding, client details, and supporting artifacts.

Report Builder interface

How It Works​

When you generate a report, Hawkra aggregates all vulnerability data for the selected network: which assets are affected, on which ports, at what severity, and with what proof. This data is merged into a DOCX template that produces a structured security assessment document ready for client delivery.

The report engine handles encryption transparently -- any encrypted notes or proof data stored in your workspace is decrypted on the fly during report generation, so the final document contains the cleartext findings.

Report Contents​

A generated report includes the following sections:

  • Cover Page -- Client name, company name, report version, and generation date.
  • Vulnerability Summary -- Total counts by severity (Critical, High, Medium, Low) and the most common vulnerabilities found.
  • Severity Distribution -- A breakdown showing how vulnerabilities are distributed across severity levels.
  • Affected Hosts -- A listing of all assets in the network with their IP addresses, hostnames, MAC addresses, and descriptions.
  • Detailed Findings -- Each vulnerability with its full details:
    • Name, CVE, and CWE identifiers
    • Severity level
    • Description and impact assessment
    • Affected hosts and ports
    • Proof of exploitation (from attached evidence)
    • Recommended fixes and references
  • Artifact Appendix -- Any supporting images or evidence files you attach during report generation.

Vulnerabilities in the report are sorted by severity (Critical first) and then by the number of affected hosts within each severity level.

Customization Options​

Required Fields​

FieldDescription
Client NameThe name of the client receiving the report (max 255 characters).
Company NameYour company or team name for the report header (max 255 characters).

Optional Fields​

FieldDescription
Report VersionA version string for the report, such as "1.0" or "Draft" (default: "1.0", max 50 characters).
Critical Finding SummaryA free-text executive summary highlighting the most critical findings (max 10,000 characters).

Upload your company logo to brand the report. The logo must be an image file (PNG, JPEG, etc.) and is placed on the cover page. Upload the logo file to your workspace first, then reference it during report generation.

Premium Feature

Custom report logos require a Premium subscription. Free-tier users can generate reports without custom branding.

Artifact Attachments​

You can attach supporting evidence to the report as artifacts. These can be:

  • Documents -- Files uploaded to your workspace's document library (category "Other").
  • Proofs -- Screenshots and evidence files attached to specific vulnerability-asset associations.

Only image files (PNG, JPEG, etc.) are included in the generated report. Non-image artifacts are skipped. Each artifact appears in the report with its name and description.

Generating a Report​

  1. Navigate to your workspace and select the network you want to report on.
  2. Open the Report section.
  3. Fill in the Client Name and Company Name.
  4. Optionally set the Report Version and write a Critical Finding Summary.
  5. Optionally upload and select a custom logo.
  6. Optionally attach artifact files for supporting evidence.
  7. Click Generate Report.
  8. The report is generated server-side and returned as a downloadable DOCX file.

Report generation form

Downloading Reports​

Once generation completes, the report downloads automatically. The filename follows the pattern:

{NetworkName}_Network_Report_{YYYYMMDD}.docx

For example: Production_LAN_Network_Report_20260303.docx

Report Limits​

Report generation is subject to tier-based monthly limits:

TierMonthly Reports
FreeLimited (check your plan details)
PremiumUnlimited
Self-HostedUnlimited

When you reach your monthly limit, Hawkra displays a message indicating how many reports you have used and suggests upgrading for unlimited access.

tip

Generate reports after completing your vulnerability assessment and remediation verification. This ensures the report reflects the most current state of the network.

tip

Use the Critical Finding Summary field to write an executive-level overview. This is often the first section a client reads, so highlight the most impactful findings and their business risk.

Permissions

Generating reports requires the EditAssets permission. Viewing report data (without generating) requires ViewAssets.