Skip to content

[ET-394] Add package type and risk accepted filters #77

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.

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

Merged
merged 21 commits into from
May 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Sysdig Secure Inline Scan Action

> 🚧 **Warning**: To use the Legacy Scanning Engine Action, please use version v3.* and visit the [previous README](./README.v3.md).
Expand All @@ -17,6 +16,9 @@ This action performs analysis on a specific container image and posts the result
| `stop-on-failed-policy-eval` | Fail the job if the Policy Evaluation is Failed. | |
| `stop-on-processing-error` | Fail the job if the Scanner terminates execution with errors. | |
| `severity-at-least` | Filtering option to only report vulnerabilities with at least the specified severity. Can take `critical`, `high`, `medium`, `low`, `negligible` or `any`. Default value "any" for no filtering. For example, if `severity-at-least` is set to `medium`, only Medium, High or Critical vulnerabilities will be reported. | `any` |
| `package-types` | Comma-separated list of package types to include in the report (e.g. `java,javascript`). Only vulnerabilities found in these types of packages will be included. If empty, no inclusion filter is applied. | |
| `not-package-types` | Comma-separated list of package types to exclude from the report (e.g. `os`). Vulnerabilities found in these types of packages will be excluded. If empty, no exclusion filter is applied. | |
| `exclude-accepted` | Set to `true` to exclude vulnerabilities that have accepted risks (`acceptedRisks`). Useful to focus only on unresolved findings. | `false` |
| `group-by-package` | Enable grouping the vulnerabilities in the SARIF report by package. Useful if you want to manage security per package or condense the number of findings. | |
| `standalone` | Enable standalone mode. Do not depend on Sysdig backend for execution, avoiding the need of specifying 'sysdig-secure-token' and 'sysdig-secure-url'. Recommended when using runners with no access to the internet. May require to specify custom `cli-scanner-url` and `db-path`. | |
| `db-path` | Specify the directory for the vulnerabilities database to use while scanning. Useful when running in standalone mode. | |
Expand All @@ -33,6 +35,23 @@ This action performs analysis on a specific container image and posts the result
| `minimum-severity` | Minimum severity to fail when scanning in IaC mode. | |
| `iac-scan-path` | Path to the IaC files to scan. | |

### Filtering Examples

- **severity-at-least:**
`medium` → Only Medium, High, and Critical findings will be reported.

- **package-types:**
`java,javascript` → Only vulnerabilities in Java or JavaScript packages will be included.

- **not-package-types:**
`os` → Excludes vulnerabilities found in OS packages.

- **exclude-accepted:**
`true` → Vulnerabilities that are marked as "accepted" (i.e., with risk acceptances) are excluded from the report.

> ℹ️ You can combine these filters to focus the report on just what you care about!

---

## SARIF Report

Expand Down
10 changes: 10 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,16 @@ inputs:
description: Filtering option to only report vulnerabilities with at least the specified severity. Can take [critical|high|medium|low|negligible|any]. Default value "any" for no filtering.
default: any
required: false
package-types:
description: "Comma-separated list of package types to include in the SARIF/summary report. Example: \"java,javascript\""
required: false
not-package-types:
description: "Comma-separated list of package types to exclude from the SARIF/summary report. Example: \"os,alpine\""
required: false
exclude-accepted:
description: "Exclude vulnerabilities that have accepted risks from SARIF/summary report. true/false"
default: "false"
required: false
group-by-package:
description: Enable grouping the vulnerabilities in the SARIF report by package.
default: "false"
Expand Down
Loading
Loading