Skip to content

docs: Clarify how suppress items are matched against files #8354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kwin wants to merge 3 commits into
base: main
Choose a base branch
from
+18 −3
Open

docs: Clarify how suppress items are matched against files #8354

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1338f01
Clarify how suppress items are matched against files
kwin Mar 6, 2026
5b80c3a
Update src/site/markdown/general/suppression.md
kwin Apr 1, 2026
6a5729a
Clarify
kwin Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions src/site/markdown/general/suppression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,21 @@ A sample suppression file would look like:
The above XML file will suppress the cpe:/a:apache:struts:2.0.0 from any file with the a matching SHA1 hash.

The following shows some other ways to suppress individual findings. Note the ways to select files using either
the sha1 hash or the filePath (the filePath can also be a regex). Additionally, there are several things that
can be suppressed - individual CPEs, individual CVEs, or all CVE entries below a specified CVSS score. The most common
would be suppressing CPEs based off of SHA1 hashes or filePath (regexes) - these entries can be generated using the

- their sha1 hash (via element `<sha1>`),
- their [package URL (PURL)][purl] (via element `<packageUrl>`),
- their Maven like coordinates (groupId/namespace, artifactId/name and version via element `<gav>`), or
- their file path (via element `<filePath>`).

The latter three can optionally be given as regular expression. The `<packageUrl>` value is matched against the dependency
specific software identifiers (can be looked up from the report) and `<gav>` against these identifiers after they have been mapped
to coordinates via `PurlIdentifier.toGav()`.
The `<filePath>` value is matched against the OS-specific absolute file path of the according dependency
(for example a path inside the local Maven repository).

Additionally, there are several ways to suppress vulnerabilities: individual CPEs, individual CVEs, or all vulnerabilities below a specified CVSS score.

The most common would be suppressing CPEs based on the identified [Package URL (PURL)][purl] - these suppression entries can be generated using the
HTML version of the report. The other common scenario would be to ignore all CVEs below a certain CVSS threshold.

```xml
Expand Down Expand Up @@ -166,3 +178,6 @@ Please see the appropriate configuration option in each interfaces configuration
- [Gradle Plugin](../dependency-check-gradle/configuration.html)
- [Ant Task](../dependency-check-ant/configuration.html)
- [Jenkins Plugin](../dependency-check-jenkins/index.html)


[purl]: https://packageurl.org/
Loading