Find what affects a release

Generate an impact report for one release to see which vulnerabilities affect it, which ones it already fixes, and what your next release must fix.

Before you start

  • A Vulnlog file that lists your releases, oldest first. --as-of follows this order, so the releases don’t need published_at.

  • A resolution on every entry that a release fixes. See Record a resolution.

In this guide, Acme Shop wants to know what affects 4.3.0 and what 4.4.0 must fix.

Generate the report for the release

  1. Generate the report with --as-of and the release:

    $ vulnlog report impact acme-shop.vl.yaml --as-of 4.3.0 -o acme-shop-4.3.0.html
    Wrote: acme-shop-4.3.0.html

    The report includes the entries of 4.3.0 and every earlier release. It counts a resolution only if its release is 4.3.0 or earlier.

  2. Open the report. The State column shows the state of each entry in 4.3.0. For the definition of each state, see States.

List what the next release must fix

Filter the same report on the states that need work:

$ vulnlog report impact acme-shop.vl.yaml --as-of 4.3.0 --state open --state "under investigation" -o todo-4.4.0.html
Wrote: todo-4.4.0.html

For Acme Shop, the report lists Spring4Shell and CVE-2023-32681. Triage the entries that are under investigation. See Triage a new scanner finding.

Variants

If you ship several components

Add --tag to limit the report to one component. See Tag entries by component.

If you check an older release

Run the report as of that release. A resolution in a later release doesn’t count, so an entry that a later release fixed shows as Open. As of 4.2.0, Log4Shell is Open, because 4.3.0 fixed it.

If you maintain several release lines

Run the report on the file of the line you want to check, for example acme-shop-3.vl.yaml. See Support several release lines.

If your scanner checks the release

Generate its suppression file with the same --as-of. See Generate suppression files.

Check the result

  • The About section of the report shows the release in the Filter line, for example as of=4.3.0.

  • Pick an Open entry and check it in the Vulnlog file. It has no resolution, or its resolution.in is a later release.

For an unknown release, the command stops with exit code 5:

error: Release not found: 9.9.9
  hint: Known releases: 4.2.0, 4.3.0, 4.4.0

For all filter options, see Filter options.