diff --git a/src/site/markdown/general/suppression.md b/src/site/markdown/general/suppression.md index 5ec418e0a1..9b056830df 100644 --- a/src/site/markdown/general/suppression.md +++ b/src/site/markdown/general/suppression.md @@ -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 ``), +- their [package URL (PURL)][purl] (via element ``), +- their Maven like coordinates (groupId/namespace, artifactId/name and version via element ``), or +- their file path (via element ``). + +The latter three can optionally be given as regular expression. The `` value is matched against the dependency +specific software identifiers (can be looked up from the report) and `` against these identifiers after they have been mapped +to coordinates via `PurlIdentifier.toGav()`. +The `` 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 @@ -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/ \ No newline at end of file