Skip to content

Template · Web pentesting · Infrastructure and AD pentesting

Vulnerability write-up template

Vulnerability write-up template in Markdown: severity, CVSS 3.1 vector, asset, evidence, impact, remediation, references and retest tracking.

By Steven Carrier Published

vulnerability-write-up-template.md

Download (3.1 KB)
Preview the file
# [ID-01] [Vulnerability title]

| | |
|---|---|
| Engagement | [Engagement name or report reference] |
| Author | [First name Last name] |
| Date discovered | [YYYY-MM-DD] |
| Write-up version | 1.0 |
| Classification | Confidential |

## Summary

| Severity | CVSS 3.1 vector | Score | Status |
|---|---|---|---|
| [Critical / High / Medium / Low / Informational] | `CVSS:3.1/AV:[N]/AC:[L]/PR:[N]/UI:[N]/S:[U]/C:[H]/I:[N]/A:[N]` | [0.0 to 10.0] | [Open / Fixed / Awaiting retest] |

Severity to score mapping (CVSS 3.1 qualitative scale): 0.0 None (Informational); 0.1 to 3.9 Low; 4.0 to 6.9 Medium; 7.0 to 8.9 High; 9.0 to 10.0 Critical.

Scoring rationale: [One or two sentences on the metrics chosen, especially those open to debate (privileges required, user interaction, scope).]

## Affected asset

| Asset | Address, URL or component | Environment |
|---|---|---|
| [Application or server] | [https://… or IP address, port, parameter] | [Staging / Production] |

Affected version or configuration: [version, build, settings].

## Description

[What is vulnerable, and why. The class of flaw (for example "broken access control"), the exact place where it sits, and the condition that makes it exploitable. Stay factual and write for a technical reader who did not take part in the test.]

## Evidence and reproduction

Prerequisites: [account used and role, network position, tools and versions].

1. [Reproduction step, with the exact request or command]
2. [Reproduction step]
3. [Observed result]

Request or command (sensitive data masked):

```text
[Request, command or configuration excerpt]
```

Response or output (relevant excerpt):

```text
[Excerpt of the response or output]
```

Screenshots and files: [references to attached files, with date and time].

Reproducibility: [always / intermittent / depends on [condition]].

## Impact

[Concrete consequence for the organisation: data exposed, actions available to an attacker, services affected. Rely on what was demonstrated; state clearly what is hypothesis.]

| Confidentiality | Integrity | Availability |
|---|---|---|
| [None / Low / High] | [None / Low / High] | [None / Low / High] |

Attacker prerequisites: [network access, account, user interaction].

## Remediation

**Priority fix**

- [Action that removes the root cause]

**Defence in depth**

- [Complementary measure that reduces impact or likelihood]

**Temporary workaround** (if the fix will take time)

- [Short-term mitigation]

Estimated effort: [low / medium / high]. Suggested owner: [team]. Recommended deadline: [YYYY-MM-DD].

## References

- [CWE-XXX: title] ([link])
- [OWASP: relevant page or chapter] ([link])
- [CVE, advisory or vendor documentation] ([link])

## Tracking and retest

| Date | Event | Status | Author |
|---|---|---|---|
| [YYYY-MM-DD] | Finding delivered to the client | Open | [Author] |
| [YYYY-MM-DD] | Fix announced by the client | [To verify] | [Client team] |
| [YYYY-MM-DD] | Retest | [Fixed / Partially fixed / Not fixed / Not retested] | [Author] |

Possible statuses: Open, Fixed, Partially fixed, Not fixed, Risk accepted, Not retested.

Retest comment: [What was rechecked, how, and any residual risk.]

A vulnerability write-up describes a single flaw, completely enough for the team doing the fix to reproduce it without having been present during the test. This template is the one used for the detailed findings in the penetration test report template, and it can be used on its own to hand over a finding during the engagement.

What the template contains

  • Summary: identifier, severity, CVSS 3.1 vector and score, status, scoring rationale.
  • Affected asset: address, component, environment, version.
  • Description: the flaw, where it sits and the condition for exploitation.
  • Evidence and reproduction: prerequisites, numbered steps, request and response, reproducibility.
  • Impact: concrete consequence and attacker prerequisites.
  • Remediation: priority fix, defence in depth, temporary workaround.
  • References: CWE, OWASP, vendor advisories.
  • Tracking and retest: status history, up to verification of the fix.

Writing tips

  • One vulnerability, one write-up: group occurrences of the same flaw and list the affected assets.
  • Compute the score from the vector, never the other way round, and justify any debatable metric.
  • Mask sensitive data in evidence (tokens, passwords, personal data): a write-up often travels further than planned.
  • Separate what was demonstrated from what is hypothesis, especially in the impact.
  • Write the remediation for the person fixing, not the person reading: a verifiable action, not a generality.
  • To produce write-ups faster, the report writing AI skill follows the same format. Once the write-up is delivered, the retest report reuses its identifier.

Convert to Word or PDF

pandoc vulnerability-write-up-template.md -o write-up.docx
pandoc vulnerability-write-up-template.md -o write-up.pdf

Sources

Related resources

  • AI prompt · Web pentesting · Infrastructure and AD pentesting

    Critical vulnerability alert prompt

    Prompt that drafts the urgent client notification when a critical vulnerability is found during testing: facts, impact and immediate containment advice.

    Published

  • AI prompt · Infrastructure and AD pentesting · Web pentesting

    CVE summary prompt

    Prompt that summarises a CVE or vendor advisory: affected versions, conditions, impact, applicability questions for the client, fix and limits.

    Published

  • Tool · Web pentesting · Infrastructure and AD pentesting

    CVSS 3.1 calculator

    Compute the CVSS 3.1 base score, severity and vector string of a vulnerability, or paste an existing vector to review it. Runs in your browser.

    Published

BEAROPS

Need a penetration test?

BEAROPS experts test your applications, infrastructure and cloud, black box or grey box, following OWASP, NIST and ANSSI guidance.