Skip to content

Commit 1338f01

Browse files
authored
Clarify how suppress items are matched against files
This closes #8351
1 parent a9c835d commit 1338f01

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

src/site/markdown/general/suppression.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,19 @@ A sample suppression file would look like:
2222
The above XML file will suppress the cpe:/a:apache:struts:2.0.0 from any file with the a matching SHA1 hash.
2323

2424
The following shows some other ways to suppress individual findings. Note the ways to select files using either
25-
the sha1 hash or the filePath (the filePath can also be a regex). Additionally, there are several things that
26-
can be suppressed - individual CPEs, individual CVEs, or all CVE entries below a specified CVSS score. The most common
25+
26+
- their sha1 hash (via element `<sha1>),
27+
- their package URL (via element `<packageUrl>`),
28+
- their Maven like coordinates (groupId/namespace, artifactId/name and version via element `<gav>`), or
29+
- their file path (via element `<filePath>`).
30+
31+
The latter three can optionally be given as regular expression. The `<packageUrl>` value is matched against the dependency
32+
specific software identifiers (can be looked up from the report) and `<gav>` against these identifiers after they have been mapped
33+
to coordinates via `PurlIdentifier.toGav()`. The latter is not always available while the former is mandatory.
34+
The `<filePath>` value is matched against the OS-specific absolute file path of the according dependency
35+
(for example a path inside the local Maven repository).
36+
37+
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
2738
would be suppressing CPEs based off of SHA1 hashes or filePath (regexes) - these entries can be generated using the
2839
HTML version of the report. The other common scenario would be to ignore all CVEs below a certain CVSS threshold.
2940

0 commit comments

Comments
 (0)