Triage your first finding

In this tutorial, you create a Vulnlog file for the Acme Shop project and record a scanner finding. You record the verdict that the finding doesn’t affect Acme Shop and generate a suppression file so the scanner stops reporting it. It takes about 10 minutes.

The finding is Text4Shell (CVE-2022-42889), a remote code execution vulnerability in the Apache Commons Text library. OWASP Dependency-Check reported it in commons-text 1.9, which Acme Shop 4.3.0 ships.

Before you start

  • Install the Vulnlog CLI. For instructions, see Install Vulnlog.

  • Install Git.

Create a project directory

Create an empty directory and make it a Git repository:

mkdir acme-shop
cd acme-shop
git init

Run every command in this tutorial from this directory.

Create the Vulnlog file

Create a Vulnlog file with the project details:

vulnlog init --organization "Acme Corp" --name "Acme Shop" --author "Acme Product Security Team" -o vulnlog.yaml

Vulnlog confirms that it created the file:

Created: vulnlog.yaml

Open vulnlog.yaml in your editor. It contains the project details and two empty lists, one for releases and one for vulnerabilities:

# $schema: https://vulnlog.dev/schema/vulnlog-v1.json
---
schemaVersion: "1"

project:
  organization: Acme Corp
  name: Acme Shop
  author: Acme Product Security Team

releases: []

vulnerabilities: []

Add the release

Every entry in a Vulnlog file names the releases it affects, so the file needs at least one release.

In vulnlog.yaml, replace the line releases: [] with release 4.3.0, published on 15 June 2026:

releases:
  - id: 4.3.0
    published_at: 2026-06-15

Save the file and check it:

vulnlog validate vulnlog.yaml
info: vulnlog.yaml: releases[4.3.0]: Unreferenced release ID '4.3.0'.
1 info
Validated: vulnlog.yaml

The file is valid. The info line tells you that no entry refers to release 4.3.0 yet. That changes in the next step.

Record the finding

Record what Dependency-Check reported. You don’t add a verdict yet, because you haven’t analysed the finding:

vulnlog modify add vulnlog.yaml --vuln-id CVE-2022-42889 \
  --name Text4Shell \
  --description "Remote code execution through string interpolation in Apache Commons Text" \
  --package "pkg:maven/org.apache.commons/commons-text@1.9" \
  --reporter dependency-check
Added: CVE-2022-42889 to vulnlog.yaml

The --package value is a package URL (PURL), a standard way to name a package, its ecosystem, and its version in one string. Here it names version 1.9 of the Maven package commons-text.

Vulnlog adds an entry to vulnerabilities:

  - id: CVE-2022-42889
    name: Text4Shell
    description: Remote code execution through string interpolation in Apache Commons Text
    releases: [4.3.0]
    packages: ["pkg:maven/org.apache.commons/commons-text@1.9"]
    reports:
      - reporter: dependency-check
        at: 2026-11-07

Vulnlog sets releases to the latest release in the file, 4.3.0, and sets the report date at to today. Your file shows the date you ran the command.

The entry has no verdict, so its state is under investigation.

Record your verdict

Suppose you’ve analysed the finding. Text4Shell needs the StringSubstitutor class, and Acme Shop only uses StringEscapeUtils. The vulnerable code is in the library, but Acme Shop never runs it.

Record the verdict not affected, the reason in your own words, and a justification from a fixed list of values:

vulnlog modify add vulnlog.yaml --vuln-id CVE-2022-42889 \
  --analysis "Acme Shop only uses StringEscapeUtils from Commons Text. The server never calls StringSubstitutor, which performs the vulnerable interpolation." \
  --verdict "not affected" \
  --justification "vulnerable code not in execute path"

Because an entry for CVE-2022-42889 already exists, Vulnlog updates it:

Updated: CVE-2022-42889 in vulnlog.yaml

Your file now looks like this, apart from the report date:

# $schema: https://vulnlog.dev/schema/vulnlog-v1.json
---
schemaVersion: "1"

project:
  organization: Acme Corp
  name: Acme Shop
  author: Acme Product Security Team

releases:
  - id: 4.3.0
    published_at: 2026-06-15

vulnerabilities:

  - id: CVE-2022-42889
    name: Text4Shell
    description: Remote code execution through string interpolation in Apache Commons Text
    releases: [4.3.0]
    packages: ["pkg:maven/org.apache.commons/commons-text@1.9"]
    reports:
      - reporter: dependency-check
        at: 2026-11-07
    analysis: >-
      Acme Shop only uses StringEscapeUtils from Commons Text. The server never calls StringSubstitutor, which performs the vulnerable
      interpolation.
    verdict: not affected
    justification: vulnerable code not in execute path

Validate the file

Check the file again. The --strict option also fails the file on warnings:

vulnlog validate --strict vulnlog.yaml
Validated: vulnlog.yaml

The info line from before is gone, because the entry now refers to release 4.3.0.

Generate the suppression file

A suppression file tells a scanner which findings to skip. Generate it from the Vulnlog file:

vulnlog suppress vulnlog.yaml

Vulnlog prints the full path of each file it writes:

Wrote: /home/you/acme-shop/dependency-check-suppressions.xml

Open dependency-check-suppressions.xml:

<!-- Generated by Vulnlog (https://vulnlog.dev). DO NOT EDIT. -->
<suppressions xmlns="https://jeremylong.github.io/DependencyCheck/dependency-suppression.1.3.xsd">
    <suppress>
        <notes>Acme Shop only uses StringEscapeUtils from Commons Text. The server never calls StringSubstitutor, which performs the vulnerable interpolation.</notes>
        <cve>CVE-2022-42889</cve>
    </suppress>
</suppressions>

The file is in Dependency-Check’s own suppression format, because the report came from dependency-check. Your analysis is in the notes element, so anyone who reads the suppression file sees why the finding is suppressed. Vulnlog included the entry because the verdict is not affected. You didn’t have to ask for the suppression.

Commit your work

Commit the Vulnlog file, but not the suppression file:

git add vulnlog.yaml
git commit -m "Triage CVE-2022-42889 (Text4Shell): not affected"

The Git history now shows who recorded the verdict, when, and why. If you later learn something that changes your verdict, you change the entry in a new commit, and the history keeps both versions.

What you’ve learned

Now you can:

  • Create a Vulnlog file and add a release to it.

  • Record a finding first and add your verdict to the same entry later.

  • Generate a suppression file from your verdicts.

Next steps