Skip to content

Commit

Permalink
docs: filtering vulnerabilities with trivy (#251)
Browse files Browse the repository at this point in the history
Co-authored-by: Sertaç Özercan <[email protected]>
  • Loading branch information
anubhav06 and sozercan authored Aug 16, 2023
1 parent cbf4117 commit ae0b05b
Show file tree
Hide file tree
Showing 9 changed files with 65 additions and 0 deletions.
64 changes: 64 additions & 0 deletions website/docs/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Troubleshooting
---

## Filtering Vulnerabilities

You might want to filter/ignore some of the vulnerabilities while patching. To do so, you need to first filter those undesired vulnerabilities from your scanner output.

For Trivy, vulnerabilities can be filtered by the following 2 ways:

### Rego Policy

An example rego file which demonstrates how to ignore certain Vulnerability IDs or Package Names:

```bash
$ cat trivy_ignore.rego

package trivy

import data.lib.trivy

default ignore = false


# Ignore the following Vulnerability IDs
ignore_vulnerability_ids := {
"CVE-2018-14618"
}
# Ignore the following Package Names
ignore_pkgs := {"bash", "vim"}


# For ignoring vulnID
ignore {
input.VulnerabilityID == ignore_vulnerability_ids[_]
}
# For ignoring pkgName
ignore {
input.PkgName == ignore_pkgs[_]
}

```

After adding the above rego file, run the image scan with the `--ignore-policy` flag followed by the file name to ignore them while scanning:

```bash
trivy image --ignore-policy trivy_ignore.rego ruby:2.4.0
```
In the above example, the vulnerability "CVE-2018-14618" and the packages "bash" & "vim" are ignored while scanning, and hence patching the image.

### Ignore File

Use a `.trivyignore` file to list all the vulnerabilities you want to ignore.

Example:
```bash
$ cat .trivyignore

# Accept the risk
CVE-2018-14618
```
In the above example, the vulnerability CVE-2018-14618 is ignored while scanning, and hence while patching the image.

For a more detailed explanation on how to ignore certain vulnerabilities with Trivy, please refer to the official documentation [here](https://aquasecurity.github.io/trivy/v0.44/docs/configuration/filtering/).
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const sidebars = {
'introduction',
'installation',
'quick-start',
'troubleshooting',
'design',
'contributing',
'code-of-conduct'
Expand Down

0 comments on commit ae0b05b

Please sign in to comment.