Vulnerabilities

Each item in vulnerabilities is an entry. An entry records one vulnerability: the releases and packages it concerns, who reported it, your verdict, and, once it’s fixed, the resolution.

Synopsis

The Log4Shell entry from the Acme Shop file shows most fields:

  - id: CVE-2021-44228
    name: Log4Shell
    description: Remote code execution through JNDI lookups in Apache Log4j
    aliases: [GHSA-jfh8-c2jp-5v3q]
    releases: [4.2.0]
    packages: ["pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1"]
    reports:
      - reporter: grype
        at: 2026-03-10
      - reporter: other
        at: 2026-03-11
        source: Customer support request
    tags:
      - backend
      - container
    analysis: >-
      The server logs the User-Agent header with log4j-core 2.14.1. A crafted header triggers a JNDI lookup and runs attacker-controlled
      code.
    analyzed_at: 2026-03-11
    verdict: affected
    severity: critical
    disposition: will fix
    resolution:
      in: 4.3.0
      at: 2026-06-15
      note: Updated log4j-core from 2.14.1 to 2.17.1

Entry

Fields are listed in the order vulnlog fmt writes them.

Field Type Required Default Description

id

String, vulnerability ID

Yes

None

Primary identifier. It must start with CVE-, GHSA-, RUSTSEC-, or SNYK-. Other IDs aren’t supported. By convention, it’s the CVE ID when one exists.

name

String

No

None

Common name, for example Log4Shell. Release notes show it.

description

String

No

None

Short description of the vulnerability.

aliases

List of vulnerability IDs

No

None

Other IDs of the same vulnerability, for example its GHSA ID. The same prefixes as for id apply. Suppression files don’t use aliases.

releases

List of release IDs

Yes

None

Releases in which the vulnerability was found. The entry also applies to every release listed after the earliest of them, until the release in resolution.in. It doesn’t apply to releases listed before the earliest one, so list the earliest affected release. Each ID must be defined in releases at the top level.

packages

List of PURLs

Yes

None

The package URLs (PURLs) of the dependencies that contain the vulnerability. Your scanner’s output usually includes them.

reports

List of report entries

Yes

None

One report for each scanner or other source that reported the vulnerability.

tags

List of tag IDs

No

No tags

Tags for filtering and for matching release PURLs. Each tag must be defined in tags at the top level. See Tags.

analysis

String

No

None

Your reasoning behind the verdict. Suppression files and the impact report include it. So do OpenVEX documents, which tell your customers' tools whether a release is affected by a vulnerability.

analyzed_at

Date, YYYY-MM-DD

No

None

Date of the analysis.

verdict

affected or not affected

No

No verdict

Whether the vulnerability affects your software. See Verdicts and justifications.

severity

low, medium, high, or critical

With affected

None

Severity for your software.

disposition

will fix or wont fix

No

Not stated

What you plan to do. Allowed only with verdict: affected.

justification

One of five values

With not affected

None

Why the vulnerability doesn’t affect your software. Allowed only with verdict: not affected. See Justification values.

resolution

Resolution

No

None

The release that fixes the vulnerability.

comment

String

No

None

Any other note. Generated output doesn’t include it.

Report

Field Type Required Default Description

reporter

One of the reporter values

Yes

None

The scanner or source that reported the vulnerability. For the values and the suppression file each one gets, see Supported scanners.

at

Date, YYYY-MM-DD

No

None

Date of the report.

source

String

With other

None

Who or what reported the vulnerability, for example Customer inquiry. Required when reporter is other.

vuln_ids

List of vulnerability IDs

No

The entry’s id

IDs this scanner uses for the vulnerability. The suppression file for this reporter lists them instead of id. The same prefixes as for id apply.

suppress

Object

No

None

Suppresses the finding for this reporter. See Suppression.

Resolution

Field Type Required Default Description

in

Release ID

Yes

None

The release that fixes the vulnerability. It must be defined in releases at the top level.

at

Date, YYYY-MM-DD

No

None

Date of the resolution.

ref

String, URI

No

None

Link to the issue, pull request, or ticket that resolves the vulnerability. Release notes show it.

note

String

No

None

How you fixed it, for example Updated log4j-core from 2.14.1 to 2.17.1. Release notes show it.

For what a resolution does to the state and the suppression files, see States and Suppression rules.

Rules

vulnlog validate checks these rules.

Rule Level Message

id, aliases, and vuln_ids start with CVE-, GHSA-, RUSTSEC-, or SNYK-. Case doesn’t matter.

Error

Unsupported vulnerability ID: ACME-2026-001

id, releases, packages, and reports are present.

Error

YAML parse error: …​ missing (therefore NULL) value for creator parameter reports …​

Each id is unique in the file.

Error

Duplicate vulnerability ID 'CVE-2022-42889'.

No alias is the id of an entry.

Error

Duplicate aliases ID 'CVE-2022-42889'.

No alias appears in two entries.

Error

Alias ID 'GHSA-JFH8-C2JP-5V3Q' is referenced in multiple vulnerabilities: CVE-2021-23337, CVE-2021-44228.

Each release in releases and resolution.in is defined.

Error

References undefined release '4.1.0'. Defined releases: 4.2.0, 4.3.0, 4.4.0

Each package is a valid PURL.

Error

Unsupported PURL: commons-text-1.9

Each tag is defined.

Error

References undefined tags 'workers'. Defined tags: backend, container, frontend, worker

reporter is a supported value.

Error

Unsupported reporter: owasp

A report with reporter: other has a source.

Error

Generic reporter without source specified.

Dates use the format YYYY-MM-DD.

Error

YAML parse error: Cannot deserialize value of type …​

analyzed_at isn’t earlier than the earliest report at.

Warning

Analyzed date '2026-05-01' is before earliest reported date '2026-05-20'.

If releases declare PURLs, each OpenVEX statement for the entry has a date. The date comes from analyzed_at, a report at, resolution.at, or the release’s published_at.

Warning

Vulnerability 'CVE-2023-32681' leaves its VEX statement undated on release '4.3.0'. Add either 'analyzed_at', a report 'at' or 'resolution.at', or set 'published_at' on the release.

Rules for verdict, severity, disposition, and justification are on Verdicts and justifications.

Examples

A minimal entry has only the four required fields. This is Acme Shop’s entry for a Dependabot finding that nobody has analysed yet, without its description and tags:

  - id: CVE-2023-32681
    releases: [4.3.0]
    packages: ["pkg:pypi/requests@2.28.2"]
    reports:
      - reporter: github-dependabot

Spring4Shell affects 4.2.0 and 4.3.0. The Trivy finding is suppressed until 31 March 2027, and comment names the release planned for the fix:

  - id: CVE-2022-22965
    name: Spring4Shell
    description: Remote code execution through data binding in Spring Framework
    releases:
      - 4.2.0
      - 4.3.0
    packages: ["pkg:maven/org.springframework/spring-beans@5.3.15"]
    reports:
      - reporter: trivy
        at: 2026-04-07
        suppress:
          expires_at: 2027-03-31
    tags:
      - backend
      - container
    analysis: >-
      Acme Shop runs as a Spring Boot executable JAR on JDK 17. The published exploit needs a WAR deployment on Apache Tomcat,
      but Spring advises all users to upgrade.
    analyzed_at: 2026-04-08
    verdict: affected
    severity: medium
    disposition: will fix
    comment: Planned for 4.4.0 together with the Spring Boot update.