feat: store artifacts in cache by default (#399)

* feat: migrate to a composite action

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* Fix tests

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* Delete an unused input

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* test: expect status code 0

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* test: not use run

https://bats-core.readthedocs.io/en/stable/writing-tests.html#when-not-to-use-run

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* feat: add 'cache' input

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* docs: update README

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* feat: pin Trivy version

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* fix: bump trivy version

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* feat: use date for cache key

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* chore: delete a comment

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* docs: update README

Signed-off-by: knqyf263 <knqyf263@gmail.com>

* refactor: resolve conflicts and use envs

Signed-off-by: knqyf263 <knqyf263@gmail.com>

---------

Signed-off-by: knqyf263 <knqyf263@gmail.com>

.github/workflows/build.yaml

@@ -1,27 +0,0 @@
-name: "build"
-on: [push, pull_request]
-env:
-  TRIVY_VERSION: 0.29.1
-jobs:
-  build:
-    name: build
-    runs-on: ubuntu-20.04
-    steps:
-
-      - name: Setup BATS
-        uses: mig4/setup-bats@v1
-        with:
-          bats-version: 1.2.1
-
-      - name: Setup Bats libs
-        uses: brokenpip3/setup-bats-libs@0.1.0
-
-      - name: Check out code
-        uses: actions/checkout@v1
-
-      - name: Install Trivy
-        run: |
-          curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin v${{ env.TRIVY_VERSION }}
-
-      - name: Test
-        run: bats -r .

.github/workflows/bump-trivy.yaml

@@ -0,0 +1,40 @@
+name: Bump trivy
+
+on:
+  workflow_dispatch:
+    inputs:
+      trivy_version:
+        required: true
+        type: string
+        description: the trivy version
+
+run-name: Bump trivy to v${{ inputs.trivy_version }}
+
+jobs:
+  bump:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Update Trivy versions
+        run: |
+          find test/data -type f -name '*.test' | xargs sed -r -i 's/"version": "[0-9]+\.[0-9]+\.[0-9]+"/"version": "${{ inputs.trivy_version }}"/'
+          sed -r -i '/^\| `version`/ s/[0-9]+\.[0-9]+\.[0-9]+/${{ inputs.trivy_version }}/g' README.md
+          sed -r -i 's/(default:[ ]*'"'"')v[0-9]+\.[0-9]+\.[0-9]+/\1v${{ inputs.trivy_version }}/' action.yaml
+
+      - name: Create PR
+        id: create-pr
+        uses: peter-evans/create-pull-request@v5
+        with:
+          token: ${{ secrets.ORG_REPO_TOKEN }}
+          title: "chore(deps): Update trivy to v${{ inputs.trivy_version }}"
+          commit-message: "chore(deps): Update trivy to v${{ inputs.trivy_version }}"
+          committer: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
+          author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
+          branch-suffix: timestamp
+          branch: bump-trivy
+          delete-branch: true
+
+      - name: Check outputs
+        run: |
+          echo "Pull Request Number - ${{ steps.create-pr.outputs.pull-request-number }}"
+          echo "Pull Request URL - ${{ steps.create-pr.outputs.pull-request-url }}"

.github/workflows/sync-trivy-checks.yaml

@@ -0,0 +1,24 @@
+name: Sync Trivy Checks
+
+on:
+  workflow_dispatch:
+env:
+  IMAGE_NAME: ${{ github.repository_owner }}/trivy-checks-act
+  REGISTRY: ghcr.io
+
+jobs:
+  sync-trivy-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Login to GitHub Packages Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Copy Trivy Checks
+        run: |
+          oras cp ghcr.io/aquasecurity/trivy-checks:1 ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest

.github/workflows/sync-trivy-db.yaml

@@ -0,0 +1,24 @@
+name: Sync Trivy DB
+
+on:
+  workflow_dispatch:
+env:
+  IMAGE_NAME: ${{ github.repository_owner }}/trivy-db-act
+  REGISTRY: ghcr.io
+
+jobs:
+  sync-trivy-db:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Login to GitHub Packages Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Copy Trivy DB
+        run: |
+          oras cp ghcr.io/aquasecurity/trivy-db:2 ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest

.github/workflows/sync-trivy-java-db.yaml

@@ -0,0 +1,24 @@
+name: Sync Trivy Java DB
+
+on:
+  workflow_dispatch:
+env:
+  IMAGE_NAME: ${{ github.repository_owner }}/trivy-java-db-act
+  REGISTRY: ghcr.io
+
+jobs:
+  sync-trivy-db:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Login to GitHub Packages Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Copy Trivy Java DB
+        run: |
+          oras cp ghcr.io/aquasecurity/trivy-java-db:1 ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest

.github/workflows/test.yaml

@@ -0,0 +1,31 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  TRIVY_VERSION: 0.56.1
+  BATS_LIB_PATH: '/usr/lib/'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Bats and bats libs
+        uses: bats-core/bats-action@2.0.0
+
+      - name: Install Trivy
+        run: |
+          curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin v${{ env.TRIVY_VERSION }}
+          trivy --version
+
+      - name: Test
+        run: bats --recursive --timing --verbose-run .
+        env:
+          TRIVY_CACHE_DIR: .cache
+          TRIVY_DISABLE_VEX_NOTICE: true
+          TRIVY_DEBUG: true

.gitignore

@@ -2,3 +2,6 @@
 *.test
 !test/data/*.test
 trivyignores
+.vscode/
+
+.cache

Dockerfile

@@ -1,5 +0,0 @@
-FROM ghcr.io/aquasecurity/trivy:0.29.1
-COPY entrypoint.sh /
-RUN apk --no-cache add bash curl
-RUN chmod +x /entrypoint.sh
-ENTRYPOINT ["/entrypoint.sh"]

Makefile

@@ -0,0 +1,15 @@
+OS := $(shell uname)
+ifeq ($(OS), Darwin)
+BATS_LIB_PATH=/opt/homebrew/lib
+endif
+ifeq ($(OS), Linux)
+BATS_LIB_PATH=/usr/local/lib/ 
+endif
+
+
+.PHONY: test
+test:
+	mkdir -p .cache
+	BATS_LIB_PATH=$(BATS_LIB_PATH) GITHUB_REPOSITORY_OWNER=aquasecurity\
+	  TRIVY_CACHE_DIR=.cache TRIVY_DISABLE_VEX_NOTICE=true TRIVY_DEBUG=true\
+	  bats --recursive --timing --verbose-run .

README.md

@@ -10,38 +10,45 @@
 
 ## Table of Contents
 
-- [Usage](#usage)
+* [Usage](#usage)
-  - [Workflow](#workflow)
+  * [Scan CI Pipeline](#scan-ci-pipeline)
-  - [Docker Image Scanning](#using-trivy-with-github-code-scanning)
+  * [Scan CI Pipeline (w/ Trivy Config)](#scan-ci-pipeline-w-trivy-config)
-  - [Git Repository Scanning](#using-trivy-to-scan-your-git-repo)
+  * [Cache](#cache)
-- [Customizing](#customizing)
+  * [Scanning a Tarball](#scanning-a-tarball)
-  - [Inputs](#inputs)
+  * [Using Trivy with GitHub Code Scanning](#using-trivy-with-github-code-scanning)
+  * [Using Trivy to scan your Git repo](#using-trivy-to-scan-your-git-repo)
+  * [Using Trivy to scan your rootfs directories](#using-trivy-to-scan-your-rootfs-directories)
+  * [Using Trivy to scan Infrastructure as Code](#using-trivy-to-scan-infrastructure-as-code)
+  * [Using Trivy to generate SBOM](#using-trivy-to-generate-sbom)
+  * [Using Trivy to scan your private registry](#using-trivy-to-scan-your-private-registry)
+  * [Using Trivy if you don't have code scanning enabled](#using-trivy-if-you-dont-have-code-scanning-enabled)
+* [Customizing](#customizing)
+  * [inputs](#inputs)
+  * [Environment variables](#environment-variables)
+  * [Trivy config file](#trivy-config-file)
 
 ## Usage
 
-### Workflow
+### Scan CI Pipeline
 
 ```yaml
 name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
-
       - name: Build an image from Dockerfile
-        run: |
+        run: docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
-          docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
-
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'table'
@@ -51,6 +58,160 @@ jobs:
           severity: 'CRITICAL,HIGH'
 ```
 
+### Scan CI Pipeline (w/ Trivy Config)
+
+```yaml
+name: build
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Run Trivy vulnerability scanner in fs mode
+      uses: aquasecurity/trivy-action@0.20.0
+      with:
+        scan-type: 'fs'
+        scan-ref: '.'
+        trivy-config: trivy.yaml
+```
+
+In this case `trivy.yaml` is a YAML configuration that is checked in as part of the repo. Detailed information is available on the Trivy website but an example is as follows:
+```yaml
+format: json
+exit-code: 1
+severity: CRITICAL
+secret:
+  config: config/trivy/secret.yaml
+```
+
+It is possible to define all options in the `trivy.yaml` file. Specifying individual options via the action are left for backward compatibility purposes. Defining the following is required as they cannot be defined with the config file:
+- `scan-ref`: If using `fs, repo` scans.
+- `image-ref`: If using `image` scan.
+- `scan-type`: To define the scan type, e.g. `image`, `fs`, `repo`, etc.
+
+#### Order of preference for options
+Trivy uses [Viper](https://github.com/spf13/viper) which has a defined precedence order for options. The order is as follows:
+- GitHub Action flag
+- Environment variable
+- Config file
+- Default
+
+### Cache
+The action has a built-in functionality for caching and restoring [the vulnerability DB](https://github.com/aquasecurity/trivy-db), [the Java DB](https://github.com/aquasecurity/trivy-java-db) and [the checks bundle](https://github.com/aquasecurity/trivy-checks) if they are downloaded during the scan.
+The cache is stored in the `$GITHUB_WORKSPACE/.cache/trivy` directory by default.
+The cache is restored before the scan starts and saved after the scan finishes.
+
+It uses [actions/cache](https://github.com/actions/cache) under the hood but requires less configuration settings.
+The cache input is optional, and caching is turned on by default.
+
+#### Disabling caching
+If you want to disable caching, set the `cache` input to `false`, but we recommend keeping it enabled to avoid rate limiting issues.
+
+```yaml
+    - name: Run Trivy scanner without cache
+      uses: aquasecurity/trivy-action@0.20.0
+      with:
+        scan-type: 'fs'
+        scan-ref: '.'
+        cache: 'false'
+```
+
+#### Updating caches in the default branch
+Please note that there are [restrictions on cache access](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache) between branches in GitHub Actions.
+By default, a workflow can access and restore a cache created in either the current branch or the default branch (usually `main` or `master`).
+If you need to share caches across branches, you may need to create a cache in the default branch and restore it in the current branch.
+
+To optimize your workflow, you can set up a cron job to regularly update the cache in the default branch.
+This allows subsequent scans to use the cached DB without downloading it again.
+
+```yaml
+# Note: This workflow only updates the cache. You should create a separate workflow for your actual Trivy scans.
+# In your scan workflow, set TRIVY_SKIP_DB_UPDATE=true and TRIVY_SKIP_JAVA_DB_UPDATE=true.
+name: Update Trivy Cache
+
+on:
+  schedule:
+    - cron: '0 0 * * *'  # Run daily at midnight UTC
+  workflow_dispatch:  # Allow manual triggering
+
+jobs:
+  update-trivy-db:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get current date
+        id: date
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
+
+      - name: Download and extract the vulnerability DB
+        run: |
+          mkdir -p $GITHUB_WORKSPACE/.cache/trivy/db
+          oras pull ghcr.io/aquasecurity/trivy-db:2
+          tar -xzf db.tar.gz -C $GITHUB_WORKSPACE/.cache/trivy/db
+          rm db.tar.gz
+
+      - name: Download and extract the Java DB
+        run: |
+          mkdir -p $GITHUB_WORKSPACE/.cache/trivy/java-db
+          oras pull ghcr.io/aquasecurity/trivy-java-db:1
+          tar -xzf javadb.tar.gz -C $GITHUB_WORKSPACE/.cache/trivy/java-db
+          rm javadb.tar.gz
+
+      - name: Cache DBs
+        uses: actions/cache/save@v4
+        with:
+          path: ${{ github.workspace }}/.cache/trivy
+          key: cache-trivy-${{ steps.date.outputs.date }}
+```
+
+When running a scan, set the environment variables `TRIVY_SKIP_DB_UPDATE` and `TRIVY_SKIP_JAVA_DB_UPDATE` to skip the download process.
+
+```yaml
+    - name: Run Trivy scanner without downloading DBs
+      uses: aquasecurity/trivy-action@0.20.0
+      with:
+        scan-type: 'image'
+        scan-ref: 'myimage'
+      env:
+        TRIVY_SKIP_DB_UPDATE: true
+        TRIVY_SKIP_JAVA_DB_UPDATE: true
+```
+
+### Scanning a Tarball
+```yaml
+name: build
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Generate tarball from image
+      run: |
+        docker pull <your-docker-image>
+        docker save -o vuln-image.tar <your-docker-image>
+
+    - name: Run Trivy vulnerability scanner in tarball mode
+      uses: aquasecurity/trivy-action@0.20.0
+      with:
+        input: /github/workspace/vuln-image.tar
+        severity: 'CRITICAL,HIGH'
+```
+
 ### Using Trivy with GitHub Code Scanning
 If you have [GitHub code scanning](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) available you can use Trivy as a scanning tool as follows:
 ```yaml
@@ -58,29 +219,29 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Build an image from Dockerfile
         run: |
           docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'sarif'
           output: 'trivy-results.sarif'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -93,29 +254,29 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Build an image from Dockerfile
         run: |
           docker build -t docker.io/my-organization/my-app:${{ github.sha }} .
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'sarif'
           output: 'trivy-results.sarif'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         if: always()
         with:
           sarif_file: 'trivy-results.sarif'
@@ -132,18 +293,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner in repo mode
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           scan-type: 'fs'
           ignore-unfixed: true
@@ -152,7 +313,7 @@ jobs:
           severity: 'CRITICAL'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -166,18 +327,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner with rootfs command
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           scan-type: 'rootfs'
           scan-ref: 'rootfs-example-binary'
@@ -187,12 +348,12 @@ jobs:
           severity: 'CRITICAL'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
 
-### Using Trivy to scan Infrastucture as Code
+### Using Trivy to scan Infrastructure as Code
 It's also possible to scan your IaC repos with Trivy's built-in repo scan. This can be handy if you want to run Trivy as a build time check on each PR that gets opened in your repo. This helps you identify potential vulnerablites that might get introduced with each PR.
 
 If you have [GitHub code scanning](https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) available you can use Trivy as a scanning tool as follows:
@@ -201,62 +362,111 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner in IaC mode
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           scan-type: 'config'
-          hide-progress: false
+          hide-progress: true
-          format: 'table'
+          format: 'sarif'
+          output: 'trivy-results.sarif'
           exit-code: '1'
           ignore-unfixed: true
           severity: 'CRITICAL,HIGH'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
 
 ### Using Trivy to generate SBOM
-It's possible for Trivy to generate an SBOM of your dependencies and submit them to a consumer like GitHub Dependency Snapshot.
+It's possible for Trivy to generate an [SBOM](https://www.aquasec.com/cloud-native-academy/supply-chain-security/sbom/) of your dependencies and submit them to a consumer like [GitHub Dependency Graph](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph).
 
-The sending of SBOM to GitHub feature is only available if you currently have [GitHub Dependency Snapshot](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api) available to you in your repo. 
+The [sending of an SBOM to GitHub](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api) feature is only available if you currently have GitHub Dependency Graph [enabled in your repo](https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-the-dependency-graph#enabling-and-disabling-the-dependency-graph-for-a-private-repository).
+
+In order to send results to GitHub Dependency Graph, you will need to create a [GitHub PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) or use the [GitHub installation access token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) (also known as `GITHUB_TOKEN`):
 
-In order to send results to the GitHub Dependency Snapshot, you will need to create a [GitHub PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
 ```yaml
 ---
 name: Pull Request
 on:
   push:
     branches:
-    - master
+    - main
-  pull_request:
+
+## GITHUB_TOKEN authentication, add only if you're not going to use a PAT
+permissions:
+  contents: write
+
 jobs:
   build:
     name: Checks
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Run Trivy in GitHub SBOM mode and submit results to Dependency Snapshots
+      - name: Run Trivy in GitHub SBOM mode and submit results to Dependency Graph
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           scan-type: 'fs'
           format: 'github'
           output: 'dependency-results.sbom.json'
           image-ref: '.'
-          github-pat: '<github_pat_token>'
+          github-pat: ${{ secrets.GITHUB_TOKEN }} # or ${{ secrets.github_pat_name }} if you're using a PAT
+```
+
+When scanning images you may want to parse the actual output JSON as Github Dependency doesn't show all details like the file path of each dependency for instance.
+
+You can upload the report as an artifact and download it, for instance using the [upload-artifact action](https://github.com/actions/upload-artifact):
+
+```yaml
+---
+name: Pull Request
+on:
+  push:
+    branches:
+    - main
+
+## GITHUB_TOKEN authentication, add only if you're not going to use a PAT
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Checks
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Scan image in a private registry
+        uses: aquasecurity/trivy-action@0.20.0
+        with:
+          image-ref: "private_image_registry/image_name:image_tag"
+          scan-type: image
+          format: 'github'
+          output: 'dependency-results.sbom.json'
+          github-pat: ${{ secrets.GITHUB_TOKEN }} # or ${{ secrets.github_pat_name }} if you're using a PAT
+          severity: "MEDIUM,HIGH,CRITICAL"
+          scanners: "vuln"
+        env:
+          TRIVY_USERNAME: "image_registry_admin_username"
+          TRIVY_PASSWORD: "image_registry_admin_password"
+
+      - name: Upload trivy report as a Github artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: trivy-sbom-report
+          path: '${{ github.workspace }}/dependency-results.sbom.json'
+          retention-days: 20 # 90 is the default
 ```
 
 ### Using Trivy to scan your private registry
@@ -270,18 +480,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'sarif'
@@ -291,7 +501,7 @@ jobs:
           TRIVY_PASSWORD: Password
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -306,18 +516,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'aws_account_id.dkr.ecr.region.amazonaws.com/imageName:${{ github.sha }}'
           format: 'sarif'
@@ -328,7 +538,7 @@ jobs:
           AWS_DEFAULT_REGION: us-west-2
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -342,18 +552,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'sarif'
@@ -362,7 +572,7 @@ jobs:
           GOOGLE_APPLICATION_CREDENTIAL: /path/to/credential.json
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -375,18 +585,18 @@ name: build
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Run Trivy vulnerability scanner
-        uses: aquasecurity/trivy-action@master
+        uses: aquasecurity/trivy-action@0.20.0
         with:
           image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
           format: 'sarif'
@@ -396,40 +606,87 @@ jobs:
           TRIVY_PASSWORD: Password
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'
 ```
 
+### Using Trivy if you don't have code scanning enabled
+
+It's also possible to browse a scan result in a workflow summary.
+
+This step is especially useful for private repositories without [GitHub Advanced Security](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security) license.
+
+```yaml
+- name: Run Trivy scanner
+  uses: aquasecurity/trivy-action@0.20.0
+  with:
+    scan-type: config
+    hide-progress: true
+    output: trivy.txt
+
+- name: Publish Trivy Output to Summary
+  run: |
+    if [[ -s trivy.txt ]]; then
+      {
+        echo "### Security Output"
+        echo "<details><summary>Click to expand</summary>"
+        echo ""
+        echo '```terraform'
+        cat trivy.txt
+        echo '```'
+        echo "</details>"
+      } >> $GITHUB_STEP_SUMMARY
+    fi
+```
+
 ## Customizing
 
+Configuration priority:
+- [Inputs](#inputs)
+- [Environment variables](#environment-variables)
+- [Trivy config file](#trivy-config-file)
+- Default values
+
+
 ### inputs
 
 Following inputs can be used as `step.with` keys:
 
-| Name              | Type    | Default                            | Description                                                                                     |
+| Name                         | Type    | Default                            | Description                                                                                                                                                    |
-|-------------------|---------|------------------------------------|-------------------------------------------------------------------------------------------------|
+|------------------------------|---------|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `scan-type`       | String  | `image`                            | Scan type, e.g. `image` or `fs`                                                                 |
+| `scan-type`                  | String  | `image`                            | Scan type, e.g. `image` or `fs`                                                                                                                                |
-| `input`           | String  |                                    | Tar reference, e.g. `alpine-latest.tar`                                                         |
+| `input`                      | String  |                                    | Tar reference, e.g. `alpine-latest.tar`                                                                                                                        |
-| `image-ref`       | String  |                                    | Image reference, e.g. `alpine:3.10.2`                                                           |
+| `image-ref`                  | String  |                                    | Image reference, e.g. `alpine:3.10.2`                                                                                                                          |
-| `scan-ref`        | String  | `/github/workspace/`               | Scan reference, e.g. `/github/workspace/` or `.`                                                |
+| `scan-ref`                   | String  | `/github/workspace/`               | Scan reference, e.g. `/github/workspace/` or `.`                                                                                                               |
-| `format`          | String  | `table`                            | Output format (`table`, `json`, `sarif`, `github`)                                              |
+| `format`                     | String  | `table`                            | Output format (`table`, `json`, `sarif`, `github`)                                                                                                             |
-| `template`        | String  |                                    | Output template (`@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)                                 |
+| `template`                   | String  |                                    | Output template (`@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)                                                                                                |
-| `output`          | String  |                                    | Save results to a file                                                                          |
+| `tf-vars`                    | String  |                                    | path to Terraform variables file                                                                                                                               |
-| `exit-code`       | String  | `0`                                | Exit code when specified vulnerabilities are found                                              |
+| `output`                     | String  |                                    | Save results to a file                                                                                                                                         |
-| `ignore-unfixed`  | Boolean | false                              | Ignore unpatched/unfixed vulnerabilities                                                        |
+| `exit-code`                  | String  | `0`                                | Exit code when specified vulnerabilities are found                                                                                                             |
-| `vuln-type`       | String  | `os,library`                       | Vulnerability types (os,library)                                                                |
+| `ignore-unfixed`             | Boolean | false                              | Ignore unpatched/unfixed vulnerabilities                                                                                                                       |
-| `severity`        | String  | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to scanned for and displayed                                      |
+| `vuln-type`                  | String  | `os,library`                       | Vulnerability types (os,library)                                                                                                                               |
-| `skip-dirs`       | String  |                                    | Comma separated list of directories where traversal is skipped                                  |
+| `severity`                   | String  | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to scanned for and displayed                                                                                                     |
-| `skip-files`      | String  |                                    | Comma separated list of files where traversal is skipped                                        |
+| `skip-dirs`                  | String  |                                    | Comma separated list of directories where traversal is skipped                                                                                                 |
-| `cache-dir`       | String  |                                    | Cache directory                                                                                 |
+| `skip-files`                 | String  |                                    | Comma separated list of files where traversal is skipped                                                                                                       |
-| `timeout`         | String  | `5m0s`                             | Scan timeout duration                                                                           |
+| `cache-dir`                  | String  | `$GITHUB_WORKSPACE/.cache/trivy`   | Cache directory                                                                                                                                                |
-| `ignore-policy`   | String  |                                    | Filter vulnerabilities with OPA rego language                                                   |
+| `timeout`                    | String  | `5m0s`                             | Scan timeout duration                                                                                                                                          |
-| `hide-progress`   | String  | `true`                             | Suppress progress bar                                                                           |
+| `ignore-policy`              | String  |                                    | Filter vulnerabilities with OPA rego language                                                                                                                  |
-| `list-all-pkgs`   | String  |                                    | Output all packages regardless of vulnerability                                                 |
+| `hide-progress`              | String  | `false`                            | Suppress progress bar and log output                                                                                                                           |
-| `security-checks` | String  | `vuln,secret`                      | comma-separated list of what security issues to detect (`vuln`,`secret`,`config`)               |
+| `list-all-pkgs`              | String  |                                    | Output all packages regardless of vulnerability                                                                                                                |
-| `trivyignores`    | String  |                                    | comma-separated list of relative paths in repository to one or more `.trivyignore` files        |
+| `scanners`                   | String  | `vuln,secret`                      | comma-separated list of what security issues to detect (`vuln`,`secret`,`config`)                                                                              |
-| `github-pat`      | String  |                                    | GitHub Personal Access Token (PAT) for sending SBOM scan results to GitHub Dependency Snapshots |
+| `trivyignores`               | String  |                                    | comma-separated list of relative paths in repository to one or more `.trivyignore` files                                                                       |
+| `trivy-config`               | String  |                                    | Path to trivy.yaml config                                                                                                                                      |
+| `github-pat`                 | String  |                                    | Authentication token to enable sending SBOM scan results to GitHub Dependency Graph. Can be either a GitHub Personal Access Token (PAT) or GITHUB_TOKEN        |
+| `limit-severities-for-sarif` | Boolean | false                              | By default *SARIF* format enforces output of all vulnerabilities regardless of configured severities. To override this behavior set this parameter to **true** |
+| `docker-host`                | String  |                                    | By default it is set to `unix://var/run/docker.sock`, but can be updated to help with containerized infrastructure values                                      |
+| `version`                    | String  | `v0.56.1`                          | Trivy version to use, e.g. `latest` or `v0.56.1`                                                                                                               |
+
+### Environment variables
+You can use [Trivy environment variables][trivy-env] to set the necessary options (including flags that are not supported by [Inputs](#inputs), such as `--secret-config`).
+
+### Trivy config file
+When using the `trivy-config` [Input](#inputs), you can set options using the [Trivy config file][trivy-config] (including flags that are not supported by [Inputs](#inputs), such as `--secret-config`).
 
 [release]: https://github.com/aquasecurity/trivy-action/releases/latest
 [release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github
@@ -437,3 +694,5 @@ Following inputs can be used as `step.with` keys:
 [marketplace-img]: https://img.shields.io/badge/marketplace-trivy--action-blue?logo=github
 [license]: https://github.com/aquasecurity/trivy-action/blob/master/LICENSE
 [license-img]: https://img.shields.io/github/license/aquasecurity/trivy-action
+[trivy-env]: https://aquasecurity.github.io/trivy/latest/docs/configuration/#environment-variables
+[trivy-config]: https://aquasecurity.github.io/trivy/latest/docs/references/configuration/config-file/

action.yaml

@@ -1,6 +1,7 @@
 name: 'Aqua Security Trivy'
 description: 'Scans container images for vulnerabilities with Trivy'
 author: 'Aqua Security'
+
 inputs:
   scan-type:
     description: 'Scan type to use for scanning vulnerability'
@@ -8,7 +9,7 @@ inputs:
     default: 'image'
   image-ref:
     description: 'image reference(for backward compatibility)'
-    required: true
+    required: false
   input:
     description: 'reference of tar file to scan'
     required: false
@@ -24,7 +25,7 @@ inputs:
     description: 'ignore unfixed vulnerabilities'
     required: false
     default: 'false'
-  vuln-type:
+  vuln-type: # TODO: rename to pkg-types
     description: 'comma-separated list of vulnerability types (os,library)'
     required: false
     default: 'os,library'
@@ -55,7 +56,7 @@ inputs:
   cache-dir:
     description: 'specify where the cache is stored'
     required: false
-    default: ''
+    default: '${{ github.workspace }}/.cache/trivy'
   timeout:
     description: 'timeout (default 5m0s)'
     required: false
@@ -65,13 +66,13 @@ inputs:
     required: false
     default: ''
   hide-progress:
-    description: 'hide progress output'
+    description: 'suppress progress bar and log output'
     required: false
   list-all-pkgs:
     description: 'output all packages regardless of vulnerability'
     required: false
     default: 'false'
-  security-checks:
+  scanners:
     description: 'comma-separated list of what security issues to detect'
     required: false
     default: ''
@@ -79,35 +80,88 @@ inputs:
     description: 'comma-separated list of relative paths in repository to one or more .trivyignore files'
     required: false
     default: ''
-  artifact-type:
-    description: 'input artifact type (image, fs, repo, archive) for SBOM generation'
-    required: false
   github-pat:
     description: 'GitHub Personal Access Token (PAT) for submitting SBOM to GitHub Dependency Snapshot API'
     required: false
+  trivy-config:
+    description: 'path to trivy.yaml config'
+    required: false
+  tf-vars:
+    description: "path to terraform tfvars file"
+    required: false
+  limit-severities-for-sarif:
+    description: 'limit severities for SARIF format'
+    required: false
+  docker-host:
+    description: 'unix domain socket path to use for docker scanning, ex. unix:///var/run/docker.sock'
+    required: false
+  version:
+    description: 'Trivy version to use'
+    required: false
+    default: 'v0.56.1'
+  cache:
+    description: 'Used to specify whether caching is needed. Set to false, if you would like to disable caching.'
+    required: false
+    default: 'true'
 
 runs:
-  using: 'docker'
+  using: 'composite'
-  image: "Dockerfile"
+  steps:
-  args:
+    - name: Install Trivy
-    - '-a ${{ inputs.scan-type }}'
+      shell: bash
-    - '-b ${{ inputs.format }}'
+      run: curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sudo sh -s -- -b /usr/local/bin ${{ inputs.version }}
-    - '-c ${{ inputs.template }}'
+
-    - '-d ${{ inputs.exit-code }}'
+    - name: Get current date
-    - '-e ${{ inputs.ignore-unfixed }}'
+      id: date
-    - '-f ${{ inputs.vuln-type }}'
+      shell: bash
-    - '-g ${{ inputs.severity }}'
+      run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
-    - '-h ${{ inputs.output }}'
+
-    - '-i ${{ inputs.image-ref }}'
+    - name: Restore DB from cache
-    - '-j ${{ inputs.scan-ref }}'
+      if: ${{ inputs.cache == 'true' }}
-    - '-k ${{ inputs.skip-dirs }}'
+      uses: actions/cache@v4
-    - '-l ${{ inputs.input }}'
+      with:
-    - '-m ${{ inputs.cache-dir }}'
+        path: ${{ inputs.cache-dir }}
-    - '-n ${{ inputs.timeout }}'
+        key: cache-trivy-${{ steps.date.outputs.date }}
-    - '-o ${{ inputs.ignore-policy }}'
+        restore-keys: cache-trivy-
-    - '-p ${{ inputs.hide-progress }}'
+
-    - '-q ${{ inputs.skip-files }}'
+    - name: Set GitHub Path
-    - '-r ${{ inputs.list-all-pkgs }}'
+      run: echo "$GITHUB_ACTION_PATH" >> $GITHUB_PATH
-    - '-s ${{ inputs.security-checks }}'
+      shell: bash
-    - '-t ${{ inputs.trivyignores }}'
+      env:
-    - '-u ${{ inputs.github-pat }}'
+        GITHUB_ACTION_PATH: ${{ github.action_path }}
+
+    - name: Run Trivy
+      shell: bash
+      run: entrypoint.sh
+      env:
+        # For shell script
+        # > If the action is written using a composite, then it will not automatically get INPUT_<VARIABLE_NAME>
+        # cf. https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#example-specifying-inputs
+        INPUT_SCAN_TYPE: ${{ inputs.scan-type }}
+        INPUT_IMAGE_REF: ${{ inputs.image-ref }}
+        INPUT_SCAN_REF: ${{ inputs.scan-ref }}
+        INPUT_TRIVYIGNORES: ${{ inputs.trivyignores }}
+        INPUT_GITHUB_PAT: ${{ inputs.github-pat }}
+        INPUT_LIMIT_SEVERITIES_FOR_SARIF: ${{ inputs.limit-severities-for-sarif }}
+
+        # For Trivy
+        # cf. https://aquasecurity.github.io/trivy/latest/docs/configuration/#environment-variables
+        TRIVY_INPUT: ${{ inputs.input }}
+        TRIVY_EXIT_CODE: ${{ inputs.exit-code }}
+        TRIVY_IGNORE_UNFIXED: ${{ inputs.ignore-unfixed }}
+        TRIVY_PKG_TYPES: ${{ inputs.vuln-type }}
+        TRIVY_SEVERITY: ${{ inputs.severity }}
+        TRIVY_FORMAT: ${{ inputs.format }}
+        TRIVY_TEMPLATE: ${{ inputs.template }}
+        TRIVY_OUTPUT: ${{ inputs.output }}
+        TRIVY_SKIP_DIRS: ${{ inputs.skip-dirs }}
+        TRIVY_SKIP_FILES: ${{ inputs.skip-files }}
+        TRIVY_CACHE_DIR: ${{ inputs.cache-dir }}
+        TRIVY_TIMEOUT: ${{ inputs.timeout }}
+        TRIVY_IGNORE_POLICY: ${{ inputs.ignore-policy }}
+        TRIVY_QUIET: ${{ inputs.hide-progress }}
+        TRIVY_LIST_ALL_PKGS: ${{ inputs.list-all-pkgs }}
+        TRIVY_SCANNERS: ${{ inputs.scanners }}
+        TRIVY_CONFIG: ${{ inputs.trivy-config }}
+        TRIVY_TF_VARS: ${{ inputs.tf-vars }}
+        TRIVY_DOCKER_HOST: ${{ inputs.docker-host }}

entrypoint.sh

@@ -1,178 +1,57 @@
 #!/bin/bash
-set -e
+set -euo pipefail
-while getopts "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:u:" o; do
-   case "${o}" in
-       a)
-         export scanType=${OPTARG}
-       ;;
-       b)
-         export format=${OPTARG}
-       ;;
-       c)
-         export template=${OPTARG}
-       ;;
-       d)
-         export exitCode=${OPTARG}
-       ;;
-       e)
-         export ignoreUnfixed=${OPTARG}
-       ;;
-       f)
-         export vulnType=${OPTARG}
-       ;;
-       g)
-         export severity=${OPTARG}
-       ;;
-       h)
-         export output=${OPTARG}
-       ;;
-       i)
-         export imageRef=${OPTARG}
-       ;;
-       j)
-         export scanRef=${OPTARG}
-       ;;
-       k)
-         export skipDirs=${OPTARG}
-       ;;
-       l)
-         export input=${OPTARG}
-       ;;
-       m)
-         export cacheDir=${OPTARG}
-       ;;
-       n)
-         export timeout=${OPTARG}
-       ;;
-       o)
-         export ignorePolicy=${OPTARG}
-       ;;
-       p)
-         export hideProgress=${OPTARG}
-       ;;
-       q)
-         export skipFiles=${OPTARG}
-       ;;
-       r)
-         export listAllPkgs=${OPTARG}
-       ;;
-       s)
-         export securityChecks=${OPTARG}
-       ;;
-       t)
-         export trivyIgnores=${OPTARG}
-       ;;
-       u)
-         export githubPAT=${OPTARG}
-       ;;
-  esac
-done
 
-scanType=$(echo $scanType | tr -d '\r')
+# Set artifact reference
-export artifactRef="${imageRef}"
+scanType="${INPUT_SCAN_TYPE:-image}"
-if [ "${scanType}" = "repo" ] || [ "${scanType}" = "fs" ] ||  [ "${scanType}" = "config" ] ||  [ "${scanType}" = "rootfs" ];then
+scanRef="${INPUT_SCAN_REF:-.}"
-  artifactRef=$(echo $scanRef | tr -d '\r')
+if [ -n "${INPUT_IMAGE_REF:-}" ]; then
-fi
+  scanRef="${INPUT_IMAGE_REF}" # backwards compatibility
-input=$(echo $input | tr -d '\r')
-if [ $input ]; then
-  artifactRef="--input $input"
-fi
-ignoreUnfixed=$(echo $ignoreUnfixed | tr -d '\r')
-hideProgress=$(echo $hideProgress | tr -d '\r')
-
-GLOBAL_ARGS=""
-if [ $cacheDir ];then
-  GLOBAL_ARGS="$GLOBAL_ARGS --cache-dir $cacheDir"
 fi
 
-SARIF_ARGS=""
+# Handle trivy ignores
-ARGS=""
+if [ -n "${INPUT_TRIVYIGNORES:-}" ]; then
-format=$(echo $format | xargs)
+  ignorefile="./trivyignores"
-if [ $format ];then
+
- ARGS="$ARGS --format $format"
+  # Clear the ignore file if it exists, or create a new empty file
-fi
+  : > "$ignorefile"
-if [ $template ] ;then
+
- ARGS="$ARGS --template $template"
+  for f in ${INPUT_TRIVYIGNORES//,/ }; do
-fi
-if [ $exitCode ];then
- ARGS="$ARGS --exit-code $exitCode"
-fi
-if [ "$ignoreUnfixed" == "true" ] && [ "$scanType" != "config" ];then
-  ARGS="$ARGS --ignore-unfixed"
-  SARIF_ARGS="$SARIF_ARGS --ignore-unfixed"
-fi
-if [ $vulnType ] && [ "$scanType" != "config" ] && [ "$scanType" != "sbom" ];then
-  ARGS="$ARGS --vuln-type $vulnType"
-  SARIF_ARGS="$SARIF_ARGS --vuln-type $vulnType"
-fi
-if [ $securityChecks ];then
-  ARGS="$ARGS --security-checks $securityChecks"
-fi
-if [ $severity ];then
-  ARGS="$ARGS --severity $severity"
-fi
-if [ $output ];then
-  ARGS="$ARGS --output $output"
-fi
-if [ $skipDirs ];then
-  for i in $(echo $skipDirs | tr "," "\n")
-  do
-    ARGS="$ARGS --skip-dirs $i"
-    SARIF_ARGS="$SARIF_ARGS --skip-dirs $i"
-  done
-fi
-if [ $trivyIgnores ];then
-  for f in $(echo $trivyIgnores | tr "," "\n")
-  do
     if [ -f "$f" ]; then
       echo "Found ignorefile '${f}':"
       cat "${f}"
-      cat "${f}" >> ./trivyignores
+      cat "${f}" >> "$ignorefile"
     else
-      echo "ERROR: cannot find ignorefile '${f}'."
+      echo "ERROR: cannot find ignorefile '${f}'." >&2
       exit 1
     fi
   done
-  ARGS="$ARGS --ignorefile ./trivyignores"
+  export TRIVY_IGNOREFILE="$ignorefile"
-fi
-if [ $timeout ];then
-  ARGS="$ARGS --timeout $timeout"
-fi
-if [ $ignorePolicy ];then
-  ARGS="$ARGS --ignore-policy $ignorePolicy"
-  SARIF_ARGS="$SARIF_ARGS --ignore-policy $ignorePolicy"
-fi
-if [ "$hideProgress" == "true" ];then
-  ARGS="$ARGS --no-progress"
 fi
 
-listAllPkgs=$(echo $listAllPkgs | tr -d '\r')
+# Handle SARIF
-if [ "$listAllPkgs" == "true" ];then
+if [ "${TRIVY_FORMAT:-}" = "sarif" ]; then
-  ARGS="$ARGS --list-all-pkgs"
+  if [ "${INPUT_LIMIT_SEVERITIES_FOR_SARIF:-false,,}" != "true" ]; then
-fi
+    echo "Building SARIF report with all severities"
-if [ "$skipFiles" ];then
+    unset TRIVY_SEVERITY
-  for i in $(echo $skipFiles | tr "," "\n")
+  else
-  do
+    echo "Building SARIF report"
-    ARGS="$ARGS --skip-files $i"
+  fi
-  done
 fi
 
-echo "Running trivy with options: ${ARGS}" "${artifactRef}"
+# Run Trivy
-echo "Global options: " "${GLOBAL_ARGS}"
+cmd=(trivy "$scanType" "$scanRef")
-trivy $GLOBAL_ARGS ${scanType} $ARGS ${artifactRef}
+echo "Running Trivy with options: ${cmd[*]}"
+"${cmd[@]}"
 returnCode=$?
 
-# SARIF is special. We output all vulnerabilities,
+if [ "${TRIVY_FORMAT:-}" = "github" ]; then
-# regardless of severity level specified in this report.
+  if [ -n "${INPUT_GITHUB_PAT:-}" ]; then
-# This is a feature, not a bug :)
+    printf "\n Uploading GitHub Dependency Snapshot"
-if [[ "${format}" == "sarif" ]]; then
+    curl -H 'Accept: application/vnd.github+json' -H "Authorization: token ${INPUT_GITHUB_PAT}" \
-  echo "Building SARIF report with options: ${SARIF_ARGS}" "${artifactRef}"
+         "https://api.github.com/repos/$GITHUB_REPOSITORY/dependency-graph/snapshots" -d @"${TRIVY_OUTPUT:-}"
-  trivy --quiet ${scanType} --format sarif --output ${output} $SARIF_ARGS ${artifactRef}
+  else
+    printf "\n Failing GitHub Dependency Snapshot. Missing github-pat" >&2
+  fi
 fi
 
-if [[ "${format}" == "github" ]] && [[ "$(echo $githubPAT | xargs)" != "" ]]; then
+exit $returnCode
-  echo "Uploading GitHub Dependency Snapshot"
-  curl -u "${githubPAT}" -H 'Content-Type: application/json' 'https://api.github.com/repos/'$GITHUB_REPOSITORY'/dependency-graph/snapshots' -d @./$(echo $output | xargs)
-fi
-
-exit $returnCode

test/data/config-sarif-report/main.tf

@@ -0,0 +1,18 @@
+# test data for trivy config with terraform variables
+
+variable "bucket_versioning_enabled" {
+  type    = string
+  default = "Disabled"
+}
+
+resource "aws_s3_bucket" "bucket" {
+  bucket = "trivy-action-bucket"
+}
+
+resource "aws_s3_bucket_versioning" "bucket_versioning" {
+  bucket = aws_s3_bucket.bucket.id
+
+  versioning_configuration {
+    status = var.bucket_versioning_enabled
+  }
+}

test/data/config-sarif-report/report.sarif

@@ -0,0 +1,74 @@
+{
+  "version": "2.1.0",
+  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/main/sarif-2.1/schema/sarif-schema-2.1.0.json",
+  "runs": [
+    {
+      "tool": {
+        "driver": {
+          "fullName": "Trivy Vulnerability Scanner",
+          "informationUri": "https://github.com/aquasecurity/trivy",
+          "name": "Trivy",
+          "rules": [
+            {
+              "id": "AVD-AWS-0089",
+              "name": "Misconfiguration",
+              "shortDescription": {
+                "text": "S3 Bucket Logging"
+              },
+              "fullDescription": {
+                "text": "Ensures S3 bucket logging is enabled for S3 buckets"
+              },
+              "defaultConfiguration": {
+                "level": "note"
+              },
+              "helpUri": "https://avd.aquasec.com/misconfig/avd-aws-0089",
+              "help": {
+                "text": "Misconfiguration AVD-AWS-0089\nType: Terraform Security Check\nSeverity: LOW\nCheck: S3 Bucket Logging\nMessage: Bucket has logging disabled\nLink: [AVD-AWS-0089](https://avd.aquasec.com/misconfig/avd-aws-0089)\nEnsures S3 bucket logging is enabled for S3 buckets",
+                "markdown": "**Misconfiguration AVD-AWS-0089**\n| Type | Severity | Check | Message | Link |\n| --- | --- | --- | --- | --- |\n|Terraform Security Check|LOW|S3 Bucket Logging|Bucket has logging disabled|[AVD-AWS-0089](https://avd.aquasec.com/misconfig/avd-aws-0089)|\n\nEnsures S3 bucket logging is enabled for S3 buckets"
+              },
+              "properties": {
+                "precision": "very-high",
+                "security-severity": "2.0",
+                "tags": [
+                  "misconfiguration",
+                  "security",
+                  "LOW"
+                ]
+              }
+            }
+          ]
+        }
+      },
+      "results": [
+        {
+          "ruleId": "AVD-AWS-0089",
+          "ruleIndex": 0,
+          "level": "note",
+          "message": {
+            "text": "Artifact: main.tf\nType: terraform\nVulnerability AVD-AWS-0089\nSeverity: LOW\nMessage: Bucket has logging disabled\nLink: [AVD-AWS-0089](https://avd.aquasec.com/misconfig/avd-aws-0089)"
+          },
+          "locations": [
+            {
+              "physicalLocation": {
+                "artifactLocation": {
+                  "uri": "main.tf",
+                  "uriBaseId": "ROOTPATH"
+                },
+                "region": {
+                  "startLine": 8,
+                  "startColumn": 1,
+                  "endLine": 10,
+                  "endColumn": 1
+                }
+              },
+              "message": {
+                "text": "main.tf"
+              }
+            }
+          ]
+        }
+      ],
+      "columnKind": "utf16CodeUnits"
+    }
+  ]
+}

test/data/config-scan/main.tf

@@ -0,0 +1,18 @@
+# test data for trivy config with terraform variables
+
+variable "bucket_versioning_enabled" {
+  type    = string
+  default = "Disabled"
+}
+
+resource "aws_s3_bucket" "bucket" {
+  bucket = "trivy-action-bucket"
+}
+
+resource "aws_s3_bucket_versioning" "bucket_versioning" {
+  bucket = aws_s3_bucket.bucket.id
+
+  versioning_configuration {
+    status = var.bucket_versioning_enabled
+  }
+}

test/data/config-scan/report.json

@@ -0,0 +1,101 @@
+{
+  "SchemaVersion": 2,
+  "ArtifactName": "test/data/config-scan",
+  "ArtifactType": "filesystem",
+  "Metadata": {
+    "ImageConfig": {
+      "architecture": "",
+      "created": "0001-01-01T00:00:00Z",
+      "os": "",
+      "rootfs": {
+        "type": "",
+        "diff_ids": null
+      },
+      "config": {}
+    }
+  },
+  "Results": [
+    {
+      "Target": ".",
+      "Class": "config",
+      "Type": "terraform",
+      "MisconfSummary": {
+        "Successes": 2,
+        "Failures": 0,
+        "Exceptions": 0
+      }
+    },
+    {
+      "Target": "main.tf",
+      "Class": "config",
+      "Type": "terraform",
+      "MisconfSummary": {
+        "Successes": 0,
+        "Failures": 1,
+        "Exceptions": 0
+      },
+      "Misconfigurations": [
+        {
+          "Type": "Terraform Security Check",
+          "ID": "AVD-AWS-0089",
+          "AVDID": "AVD-AWS-0089",
+          "Title": "S3 Bucket Logging",
+          "Description": "Ensures S3 bucket logging is enabled for S3 buckets",
+          "Message": "Bucket has logging disabled",
+          "Namespace": "builtin.aws.s3.aws0089",
+          "Query": "data.builtin.aws.s3.aws0089.deny",
+          "Resolution": "Add a logging block to the resource to enable access logging",
+          "Severity": "LOW",
+          "PrimaryURL": "https://avd.aquasec.com/misconfig/avd-aws-0089",
+          "References": [
+            "https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerLogs.html",
+            "https://avd.aquasec.com/misconfig/avd-aws-0089"
+          ],
+          "Status": "FAIL",
+          "Layer": {},
+          "CauseMetadata": {
+            "Resource": "aws_s3_bucket.bucket",
+            "Provider": "AWS",
+            "Service": "s3",
+            "StartLine": 8,
+            "EndLine": 10,
+            "Code": {
+              "Lines": [
+                {
+                  "Number": 8,
+                  "Content": "resource \"aws_s3_bucket\" \"bucket\" {",
+                  "IsCause": true,
+                  "Annotation": "",
+                  "Truncated": false,
+                  "Highlighted": "\u001b[38;5;33mresource\u001b[0m \u001b[38;5;37m\"aws_s3_bucket\"\u001b[0m \u001b[38;5;37m\"bucket\"\u001b[0m {",
+                  "FirstCause": true,
+                  "LastCause": false
+                },
+                {
+                  "Number": 9,
+                  "Content": "  bucket = \"trivy-action-bucket\"",
+                  "IsCause": true,
+                  "Annotation": "",
+                  "Truncated": false,
+                  "Highlighted": "  \u001b[38;5;245mbucket\u001b[0m = \u001b[38;5;37m\"trivy-action-bucket\"",
+                  "FirstCause": false,
+                  "LastCause": false
+                },
+                {
+                  "Number": 10,
+                  "Content": "}",
+                  "IsCause": true,
+                  "Annotation": "",
+                  "Truncated": false,
+                  "Highlighted": "\u001b[0m}",
+                  "FirstCause": false,
+                  "LastCause": true
+                }
+              ]
+            }
+          }
+        }
+      ]
+    }
+  ]
+}

test/data/config.test

@@ -1,56 +0,0 @@
-{
-  "SchemaVersion": 2,
-  "ArtifactName": ".",
-  "ArtifactType": "filesystem",
-  "Metadata": {
-    "ImageConfig": {
-      "architecture": "",
-      "created": "0001-01-01T00:00:00Z",
-      "os": "",
-      "rootfs": {
-        "type": "",
-        "diff_ids": null
-      },
-      "config": {}
-    }
-  },
-  "Results": [
-    {
-      "Target": "Dockerfile",
-      "Class": "config",
-      "Type": "dockerfile",
-      "MisconfSummary": {
-        "Successes": 21,
-        "Failures": 1,
-        "Exceptions": 0
-      },
-      "Misconfigurations": [
-        {
-          "Type": "Dockerfile Security Check",
-          "ID": "DS002",
-          "Title": "Image user should not be 'root'",
-          "Description": "Running containers with 'root' user can lead to a container escape situation. It is a best practice to run containers as non-root users, which can be done by adding a 'USER' statement to the Dockerfile.",
-          "Message": "Specify at least 1 USER command in Dockerfile with non-root user as argument",
-          "Namespace": "builtin.dockerfile.DS002",
-          "Query": "data.builtin.dockerfile.DS002.deny",
-          "Resolution": "Add 'USER \u003cnon root user name\u003e' line to the Dockerfile",
-          "Severity": "HIGH",
-          "PrimaryURL": "https://avd.aquasec.com/misconfig/ds002",
-          "References": [
-            "https://docs.docker.com/develop/develop-images/dockerfile_best-practices/",
-            "https://avd.aquasec.com/misconfig/ds002"
-          ],
-          "Status": "FAIL",
-          "Layer": {},
-          "CauseMetadata": {
-            "Provider": "Dockerfile",
-            "Service": "general",
-            "Code": {
-              "Lines": null
-            }
-          }
-        }
-      ]
-    }
-  ]
-}

test/data/fs-scheck.test

@@ -1,56 +0,0 @@
-{
-  "SchemaVersion": 2,
-  "ArtifactName": ".",
-  "ArtifactType": "filesystem",
-  "Metadata": {
-    "ImageConfig": {
-      "architecture": "",
-      "created": "0001-01-01T00:00:00Z",
-      "os": "",
-      "rootfs": {
-        "type": "",
-        "diff_ids": null
-      },
-      "config": {}
-    }
-  },
-  "Results": [
-    {
-      "Target": "Dockerfile",
-      "Class": "config",
-      "Type": "dockerfile",
-      "MisconfSummary": {
-        "Successes": 21,
-        "Failures": 1,
-        "Exceptions": 0
-      },
-      "Misconfigurations": [
-        {
-          "Type": "Dockerfile Security Check",
-          "ID": "DS002",
-          "Title": "Image user should not be 'root'",
-          "Description": "Running containers with 'root' user can lead to a container escape situation. It is a best practice to run containers as non-root users, which can be done by adding a 'USER' statement to the Dockerfile.",
-          "Message": "Specify at least 1 USER command in Dockerfile with non-root user as argument",
-          "Namespace": "builtin.dockerfile.DS002",
-          "Query": "data.builtin.dockerfile.DS002.deny",
-          "Resolution": "Add 'USER \u003cnon root user name\u003e' line to the Dockerfile",
-          "Severity": "HIGH",
-          "PrimaryURL": "https://avd.aquasec.com/misconfig/ds002",
-          "References": [
-            "https://docs.docker.com/develop/develop-images/dockerfile_best-practices/",
-            "https://avd.aquasec.com/misconfig/ds002"
-          ],
-          "Status": "FAIL",
-          "Layer": {},
-          "CauseMetadata": {
-            "Provider": "Dockerfile",
-            "Service": "general",
-            "Code": {
-              "Lines": null
-            }
-          }
-        }
-      ]
-    }
-  ]
-}

test/data/fs.test

@@ -1,17 +0,0 @@
-{
-  "SchemaVersion": 2,
-  "ArtifactName": ".",
-  "ArtifactType": "filesystem",
-  "Metadata": {
-    "ImageConfig": {
-      "architecture": "",
-      "created": "0001-01-01T00:00:00Z",
-      "os": "",
-      "rootfs": {
-        "type": "",
-        "diff_ids": null
-      },
-      "config": {}
-    }
-  }
-}

test/data/image-scan/report

@@ -0,0 +1,98 @@
+
+knqyf263/vuln-image:1.2.3 (alpine 3.7.1)
+========================================
+Total: 19 (CRITICAL: 19)
+
+┌─────────────┬────────────────┬──────────┬────────┬───────────────────┬───────────────┬──────────────────────────────────────────────────────────────┐
+│   Library   │ Vulnerability  │ Severity │ Status │ Installed Version │ Fixed Version │                            Title                             │
+├─────────────┼────────────────┼──────────┼────────┼───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ curl        │ CVE-2018-14618 │ CRITICAL │ fixed  │ 7.61.0-r0         │ 7.61.1-r0     │ curl: NTLM password overflow via integer overflow            │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-14618                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16839 │          │        │                   │ 7.61.1-r1     │ curl: Integer overflow leading to heap-based buffer overflow │
+│             │                │          │        │                   │               │ in Curl_sasl_create_plain_message()                          │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16839                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16840 │          │        │                   │               │ curl: Use-after-free when closing "easy" handle in           │
+│             │                │          │        │                   │               │ Curl_close()                                                 │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16840                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16842 │          │        │                   │               │ curl: Heap-based buffer over-read in the curl tool warning   │
+│             │                │          │        │                   │               │ formatting                                                   │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16842                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-3822  │          │        │                   │ 7.61.1-r2     │ curl: NTLMv2 type-3 header stack buffer overflow             │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-3822                    │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5481  │          │        │                   │ 7.61.1-r3     │ curl: double free due to subsequent call of realloc()        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5481                    │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5482  │          │        │                   │               │ curl: heap buffer overflow in function tftp_receive_packet() │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5482                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ git         │ CVE-2018-17456 │          │        │ 2.15.2-r0         │ 2.15.3-r0     │ git: arbitrary code execution via .gitmodules                │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-17456                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-1353  │          │        │                   │ 2.15.4-r0     │ git: NTFS protections inactive when running Git in the       │
+│             │                │          │        │                   │               │ Windows Subsystem for...                                     │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-1353                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ libbz2      │ CVE-2019-12900 │          │        │ 1.0.6-r6          │ 1.0.6-r7      │ bzip2: out-of-bounds write in function BZ2_decompress        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-12900                   │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ libcurl     │ CVE-2018-16839 │          │        │ 7.61.1-r0         │ 7.61.1-r1     │ curl: Integer overflow leading to heap-based buffer overflow │
+│             │                │          │        │                   │               │ in Curl_sasl_create_plain_message()                          │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16839                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16840 │          │        │                   │               │ curl: Use-after-free when closing "easy" handle in           │
+│             │                │          │        │                   │               │ Curl_close()                                                 │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16840                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16842 │          │        │                   │               │ curl: Heap-based buffer over-read in the curl tool warning   │
+│             │                │          │        │                   │               │ formatting                                                   │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16842                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-3822  │          │        │                   │ 7.61.1-r2     │ curl: NTLMv2 type-3 header stack buffer overflow             │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-3822                    │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5481  │          │        │                   │ 7.61.1-r3     │ curl: double free due to subsequent call of realloc()        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5481                    │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5482  │          │        │                   │               │ curl: heap buffer overflow in function tftp_receive_packet() │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5482                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ musl        │ CVE-2019-14697 │          │        │ 1.1.18-r3         │ 1.1.18-r4     │ musl libc through 1.1.23 has an x87 floating-point stack     │
+│             │                │          │        │                   │               │ adjustment im ......                                         │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-14697                   │
+├─────────────┤                │          │        │                   │               │                                                              │
+│ musl-utils  │                │          │        │                   │               │                                                              │
+│             │                │          │        │                   │               │                                                              │
+│             │                │          │        │                   │               │                                                              │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ sqlite-libs │ CVE-2019-8457  │          │        │ 3.21.0-r1         │ 3.25.3-r1     │ sqlite: heap out-of-bound read in function rtreenode()       │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-8457                    │
+└─────────────┴────────────────┴──────────┴────────┴───────────────────┴───────────────┴──────────────────────────────────────────────────────────────┘
+
+rust-app/Cargo.lock (cargo)
+===========================
+Total: 4 (CRITICAL: 4)
+
+┌───────────┬────────────────┬──────────┬────────┬───────────────────┬───────────────┬─────────────────────────────────────────────────────────────┐
+│  Library  │ Vulnerability  │ Severity │ Status │ Installed Version │ Fixed Version │                            Title                            │
+├───────────┼────────────────┼──────────┼────────┼───────────────────┼───────────────┼─────────────────────────────────────────────────────────────┤
+│ rand_core │ CVE-2020-25576 │ CRITICAL │ fixed  │ 0.4.0             │ 0.4.2, 0.3.1  │ An issue was discovered in the rand_core crate before 0.4.2 │
+│           │                │          │        │                   │               │ for Rust....                                                │
+│           │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2020-25576                  │
+├───────────┼────────────────┤          │        ├───────────────────┼───────────────┼─────────────────────────────────────────────────────────────┤
+│ smallvec  │ CVE-2019-15551 │          │        │ 0.6.9             │ 0.6.10        │ An issue was discovered in the smallvec crate before 0.6.10 │
+│           │                │          │        │                   │               │ for Rust....                                                │
+│           │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-15551                  │
+│           ├────────────────┤          │        │                   │               ├─────────────────────────────────────────────────────────────┤
+│           │ CVE-2019-15554 │          │        │                   │               │ An issue was discovered in the smallvec crate before 0.6.10 │
+│           │                │          │        │                   │               │ for Rust....                                                │
+│           │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-15554                  │
+│           ├────────────────┤          │        │                   ├───────────────┼─────────────────────────────────────────────────────────────┤
+│           │ CVE-2021-25900 │          │        │                   │ 0.6.14, 1.6.1 │ An issue was discovered in the smallvec crate before 0.6.14 │
+│           │                │          │        │                   │               │ and 1.x...                                                  │
+│           │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2021-25900                  │
+└───────────┴────────────────┴──────────┴────────┴───────────────────┴───────────────┴─────────────────────────────────────────────────────────────┘

test/data/repo.test

@@ -1,34 +0,0 @@
-{
-  "SchemaVersion": 2,
-  "ArtifactName": "https://github.com/krol3/demo-trivy/",
-  "ArtifactType": "repository",
-  "Metadata": {
-    "ImageConfig": {
-      "architecture": "",
-      "created": "0001-01-01T00:00:00Z",
-      "os": "",
-      "rootfs": {
-        "type": "",
-        "diff_ids": null
-      },
-      "config": {}
-    }
-  },
-  "Results": [
-    {
-      "Target": "env",
-      "Class": "secret",
-      "Secrets": [
-        {
-          "RuleID": "github-pat",
-          "Category": "GitHub",
-          "Severity": "CRITICAL",
-          "Title": "GitHub Personal Access Token",
-          "StartLine": 5,
-          "EndLine": 5,
-          "Match": "export GITHUB_PAT=*****"
-        }
-      ]
-    }
-  ]
-}

test/data/rootfs.test

@@ -1,17 +0,0 @@
-{
-  "SchemaVersion": 2,
-  "ArtifactName": ".",
-  "ArtifactType": "filesystem",
-  "Metadata": {
-    "ImageConfig": {
-      "architecture": "",
-      "created": "0001-01-01T00:00:00Z",
-      "os": "",
-      "rootfs": {
-        "type": "",
-        "diff_ids": null
-      },
-      "config": {}
-    }
-  }
-}

test/data/secret-scan/report.json

@@ -0,0 +1,77 @@
+{
+  "SchemaVersion": 2,
+  "ArtifactName": "https://github.com/krol3/demo-trivy/",
+  "ArtifactType": "repository",
+  "Metadata": {
+    "ImageConfig": {
+      "architecture": "",
+      "created": "0001-01-01T00:00:00Z",
+      "os": "",
+      "rootfs": {
+        "type": "",
+        "diff_ids": null
+      },
+      "config": {}
+    }
+  },
+  "Results": [
+    {
+      "Target": "env",
+      "Class": "secret",
+      "Secrets": [
+        {
+          "RuleID": "github-pat",
+          "Category": "GitHub",
+          "Severity": "CRITICAL",
+          "Title": "GitHub Personal Access Token",
+          "StartLine": 5,
+          "EndLine": 5,
+          "Code": {
+            "Lines": [
+              {
+                "Number": 3,
+                "Content": "export AWS_ACCESS_KEY_ID=1234567",
+                "IsCause": false,
+                "Annotation": "",
+                "Truncated": false,
+                "Highlighted": "export AWS_ACCESS_KEY_ID=1234567",
+                "FirstCause": false,
+                "LastCause": false
+              },
+              {
+                "Number": 4,
+                "Content": "",
+                "IsCause": false,
+                "Annotation": "",
+                "Truncated": false,
+                "FirstCause": false,
+                "LastCause": false
+              },
+              {
+                "Number": 5,
+                "Content": "export GITHUB_PAT=****************************************",
+                "IsCause": true,
+                "Annotation": "",
+                "Truncated": false,
+                "Highlighted": "export GITHUB_PAT=****************************************",
+                "FirstCause": true,
+                "LastCause": true
+              },
+              {
+                "Number": 6,
+                "Content": "",
+                "IsCause": false,
+                "Annotation": "",
+                "Truncated": false,
+                "FirstCause": false,
+                "LastCause": false
+              }
+            ]
+          },
+          "Match": "export GITHUB_PAT=****************************************",
+          "Layer": {}
+        }
+      ]
+    }
+  ]
+}

test/data/with-ignore-files/report

@@ -0,0 +1,86 @@
+
+knqyf263/vuln-image:1.2.3 (alpine 3.7.1)
+========================================
+Total: 19 (CRITICAL: 19)
+
+┌─────────────┬────────────────┬──────────┬────────┬───────────────────┬───────────────┬──────────────────────────────────────────────────────────────┐
+│   Library   │ Vulnerability  │ Severity │ Status │ Installed Version │ Fixed Version │                            Title                             │
+├─────────────┼────────────────┼──────────┼────────┼───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ curl        │ CVE-2018-14618 │ CRITICAL │ fixed  │ 7.61.0-r0         │ 7.61.1-r0     │ curl: NTLM password overflow via integer overflow            │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-14618                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16839 │          │        │                   │ 7.61.1-r1     │ curl: Integer overflow leading to heap-based buffer overflow │
+│             │                │          │        │                   │               │ in Curl_sasl_create_plain_message()                          │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16839                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16840 │          │        │                   │               │ curl: Use-after-free when closing "easy" handle in           │
+│             │                │          │        │                   │               │ Curl_close()                                                 │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16840                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16842 │          │        │                   │               │ curl: Heap-based buffer over-read in the curl tool warning   │
+│             │                │          │        │                   │               │ formatting                                                   │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16842                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-3822  │          │        │                   │ 7.61.1-r2     │ curl: NTLMv2 type-3 header stack buffer overflow             │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-3822                    │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5481  │          │        │                   │ 7.61.1-r3     │ curl: double free due to subsequent call of realloc()        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5481                    │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5482  │          │        │                   │               │ curl: heap buffer overflow in function tftp_receive_packet() │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5482                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ git         │ CVE-2018-17456 │          │        │ 2.15.2-r0         │ 2.15.3-r0     │ git: arbitrary code execution via .gitmodules                │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-17456                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-1353  │          │        │                   │ 2.15.4-r0     │ git: NTFS protections inactive when running Git in the       │
+│             │                │          │        │                   │               │ Windows Subsystem for...                                     │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-1353                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ libbz2      │ CVE-2019-12900 │          │        │ 1.0.6-r6          │ 1.0.6-r7      │ bzip2: out-of-bounds write in function BZ2_decompress        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-12900                   │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ libcurl     │ CVE-2018-16839 │          │        │ 7.61.1-r0         │ 7.61.1-r1     │ curl: Integer overflow leading to heap-based buffer overflow │
+│             │                │          │        │                   │               │ in Curl_sasl_create_plain_message()                          │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16839                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16840 │          │        │                   │               │ curl: Use-after-free when closing "easy" handle in           │
+│             │                │          │        │                   │               │ Curl_close()                                                 │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16840                   │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2018-16842 │          │        │                   │               │ curl: Heap-based buffer over-read in the curl tool warning   │
+│             │                │          │        │                   │               │ formatting                                                   │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2018-16842                   │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-3822  │          │        │                   │ 7.61.1-r2     │ curl: NTLMv2 type-3 header stack buffer overflow             │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-3822                    │
+│             ├────────────────┤          │        │                   ├───────────────┼──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5481  │          │        │                   │ 7.61.1-r3     │ curl: double free due to subsequent call of realloc()        │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5481                    │
+│             ├────────────────┤          │        │                   │               ├──────────────────────────────────────────────────────────────┤
+│             │ CVE-2019-5482  │          │        │                   │               │ curl: heap buffer overflow in function tftp_receive_packet() │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-5482                    │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ musl        │ CVE-2019-14697 │          │        │ 1.1.18-r3         │ 1.1.18-r4     │ musl libc through 1.1.23 has an x87 floating-point stack     │
+│             │                │          │        │                   │               │ adjustment im ......                                         │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-14697                   │
+├─────────────┤                │          │        │                   │               │                                                              │
+│ musl-utils  │                │          │        │                   │               │                                                              │
+│             │                │          │        │                   │               │                                                              │
+│             │                │          │        │                   │               │                                                              │
+├─────────────┼────────────────┤          │        ├───────────────────┼───────────────┼──────────────────────────────────────────────────────────────┤
+│ sqlite-libs │ CVE-2019-8457  │          │        │ 3.21.0-r1         │ 3.25.3-r1     │ sqlite: heap out-of-bound read in function rtreenode()       │
+│             │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2019-8457                    │
+└─────────────┴────────────────┴──────────┴────────┴───────────────────┴───────────────┴──────────────────────────────────────────────────────────────┘
+
+rust-app/Cargo.lock (cargo)
+===========================
+Total: 1 (CRITICAL: 1)
+
+┌──────────┬────────────────┬──────────┬────────┬───────────────────┬───────────────┬─────────────────────────────────────────────────────────────┐
+│ Library  │ Vulnerability  │ Severity │ Status │ Installed Version │ Fixed Version │                            Title                            │
+├──────────┼────────────────┼──────────┼────────┼───────────────────┼───────────────┼─────────────────────────────────────────────────────────────┤
+│ smallvec │ CVE-2021-25900 │ CRITICAL │ fixed  │ 0.6.9             │ 0.6.14, 1.6.1 │ An issue was discovered in the smallvec crate before 0.6.14 │
+│          │                │          │        │                   │               │ and 1.x...                                                  │
+│          │                │          │        │                   │               │ https://avd.aquasec.com/nvd/cve-2021-25900                  │
+└──────────┴────────────────┴──────────┴────────┴───────────────────┴───────────────┴─────────────────────────────────────────────────────────────┘

test/data/with-tf-vars/dev.tfvars

@@ -0,0 +1,2 @@
+# test data for trivy config with terraform variables
+bucket_versioning_enabled="Enabled"

test/data/with-tf-vars/main.tf

@@ -0,0 +1,18 @@
+# test data for trivy config with terraform variables
+
+variable "bucket_versioning_enabled" {
+  type    = string
+  default = "Disabled"
+}
+
+resource "aws_s3_bucket" "bucket" {
+  bucket = "trivy-action-bucket"
+}
+
+resource "aws_s3_bucket_versioning" "bucket_versioning" {
+  bucket = aws_s3_bucket.bucket.id
+
+  versioning_configuration {
+    status = var.bucket_versioning_enabled
+  }
+}

test/data/with-tf-vars/report.json

@@ -0,0 +1,34 @@
+{
+  "SchemaVersion": 2,
+  "ArtifactName": "test/data/with-tf-vars/main.tf",
+  "ArtifactType": "filesystem",
+  "Metadata": {
+    "ImageConfig": {
+      "architecture": "",
+      "created": "0001-01-01T00:00:00Z",
+      "os": "",
+      "rootfs": {
+        "type": "",
+        "diff_ids": null
+      },
+      "config": {}
+    }
+  },
+  "Results": [
+    {
+      "Target": ".",
+      "Class": "config",
+      "Type": "terraform",
+      "MisconfSummary": {
+        "Successes": 2,
+        "Failures": 0,
+        "Exceptions": 0
+      }
+    },
+    {
+      "Target": "main.tf",
+      "Class": "config",
+      "Type": "terraform"
+    }
+  ]
+}

test/data/with-trivy-yaml-cfg/report.json

@@ -0,0 +1,122 @@
+{
+  "SchemaVersion": 2,
+  "ArtifactName": "alpine:3.10",
+  "ArtifactType": "container_image",
+  "Metadata": {
+    "OS": {
+      "Family": "alpine",
+      "Name": "3.10.9",
+      "EOSL": true
+    },
+    "ImageID": "sha256:e7b300aee9f9bf3433d32bc9305bfdd22183beb59d933b48d77ab56ba53a197a",
+    "DiffIDs": [
+      "sha256:9fb3aa2f8b8023a4bebbf92aa567caf88e38e969ada9f0ac12643b2847391635"
+    ],
+    "RepoTags": [
+      "alpine:3.10"
+    ],
+    "RepoDigests": [
+      "alpine@sha256:451eee8bedcb2f029756dc3e9d73bab0e7943c1ac55cff3a4861c52a0fdd3e98"
+    ],
+    "ImageConfig": {
+      "architecture": "amd64",
+      "container": "fdb7e80e3339e8d0599282e606c907aa5881ee4c668a68136119e6dfac6ce3a4",
+      "created": "2021-04-14T19:20:05.338397761Z",
+      "docker_version": "19.03.12",
+      "history": [
+        {
+          "created": "2021-04-14T19:20:04.987219124Z",
+          "created_by": "/bin/sh -c #(nop) ADD file:c5377eaa926bf412dd8d4a08b0a1f2399cfd708743533b0aa03b53d14cb4bb4e in / "
+        },
+        {
+          "created": "2021-04-14T19:20:05.338397761Z",
+          "created_by": "/bin/sh -c #(nop)  CMD [\"/bin/sh\"]",
+          "empty_layer": true
+        }
+      ],
+      "os": "linux",
+      "rootfs": {
+        "type": "layers",
+        "diff_ids": [
+          "sha256:9fb3aa2f8b8023a4bebbf92aa567caf88e38e969ada9f0ac12643b2847391635"
+        ]
+      },
+      "config": {
+        "Cmd": [
+          "/bin/sh"
+        ],
+        "Env": [
+          "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
+        ],
+        "Image": "sha256:eb2080c455e94c22ae35b3aef9e078c492a00795412e026e4d6b41ef64bc7dd8"
+      }
+    }
+  },
+  "Results": [
+    {
+      "Target": "alpine:3.10 (alpine 3.10.9)",
+      "Class": "os-pkgs",
+      "Type": "alpine",
+      "Vulnerabilities": [
+        {
+          "VulnerabilityID": "CVE-2021-36159",
+          "PkgID": "apk-tools@2.10.6-r0",
+          "PkgName": "apk-tools",
+          "PkgIdentifier": {
+            "PURL": "pkg:apk/alpine/apk-tools@2.10.6-r0?arch=x86_64&distro=3.10.9",
+            "UID": "99f6581ffed6b22"
+          },
+          "InstalledVersion": "2.10.6-r0",
+          "FixedVersion": "2.10.7-r0",
+          "Status": "fixed",
+          "Layer": {
+            "Digest": "sha256:396c31837116ac290458afcb928f68b6cc1c7bdd6963fc72f52f365a2a89c1b5",
+            "DiffID": "sha256:9fb3aa2f8b8023a4bebbf92aa567caf88e38e969ada9f0ac12643b2847391635"
+          },
+          "SeveritySource": "nvd",
+          "PrimaryURL": "https://avd.aquasec.com/nvd/cve-2021-36159",
+          "DataSource": {
+            "ID": "alpine",
+            "Name": "Alpine Secdb",
+            "URL": "https://secdb.alpinelinux.org/"
+          },
+          "Title": "libfetch: an out of boundary read while libfetch uses strtol to parse the relevant numbers into address bytes leads to information leak or crash",
+          "Description": "libfetch before 2021-07-26, as used in apk-tools, xbps, and other products, mishandles numeric strings for the FTP and HTTP protocols. The FTP passive mode implementation allows an out-of-bounds read because strtol is used to parse the relevant numbers into address bytes. It does not check if the line ends prematurely. If it does, the for-loop condition checks for the '\\0' terminator one byte too late.",
+          "Severity": "CRITICAL",
+          "CweIDs": [
+            "CWE-125"
+          ],
+          "VendorSeverity": {
+            "nvd": 4,
+            "redhat": 3
+          },
+          "CVSS": {
+            "nvd": {
+              "V2Vector": "AV:N/AC:L/Au:N/C:P/I:N/A:P",
+              "V3Vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:H",
+              "V2Score": 6.4,
+              "V3Score": 9.1
+            },
+            "redhat": {
+              "V3Vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:H",
+              "V3Score": 9.1
+            }
+          },
+          "References": [
+            "https://access.redhat.com/security/cve/CVE-2021-36159",
+            "https://github.com/freebsd/freebsd-src/commits/main/lib/libfetch",
+            "https://gitlab.alpinelinux.org/alpine/apk-tools/-/issues/10749",
+            "https://lists.apache.org/thread.html/r61db8e7dcb56dc000a5387a88f7a473bacec5ee01b9ff3f55308aacc%40%3Cdev.kafka.apache.org%3E",
+            "https://lists.apache.org/thread.html/r61db8e7dcb56dc000a5387a88f7a473bacec5ee01b9ff3f55308aacc%40%3Cusers.kafka.apache.org%3E",
+            "https://lists.apache.org/thread.html/rbf4ce74b0d1fa9810dec50ba3ace0caeea677af7c27a97111c06ccb7%40%3Cdev.kafka.apache.org%3E",
+            "https://lists.apache.org/thread.html/rbf4ce74b0d1fa9810dec50ba3ace0caeea677af7c27a97111c06ccb7%40%3Cusers.kafka.apache.org%3E",
+            "https://nvd.nist.gov/vuln/detail/CVE-2021-36159",
+            "https://www.cve.org/CVERecord?id=CVE-2021-36159"
+          ],
+          "PublishedDate": "2021-08-03T14:15:08.233Z",
+          "LastModifiedDate": "2023-11-07T03:36:43.337Z"
+        }
+      ]
+    }
+  ]
+}

test/data/with-trivy-yaml-cfg/trivy.yaml

@@ -0,0 +1,5 @@
+format: json
+severity: CRITICAL
+vulnerability:
+  type: os
+output: yamlconfig.json

test/test.bats

@@ -1,65 +1,152 @@
 #!/usr/bin/env bats
-load '/usr/lib/bats-support/load.bash'
-load '/usr/lib/bats-assert/load.bash'
 
-@test "trivy image" {
+setup_file() {
-  # trivy image --severity CRITICAL --format json --output image.test knqyf263/vuln-image:1.2.3
+  local owner=$GITHUB_REPOSITORY_OWNER
-  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-b json' '-h image.test' '-g CRITICAL'
+  export TRIVY_DB_REPOSITORY=ghcr.io/${owner}/trivy-db-act:latest
-  result="$(diff ./test/data/image.test image.test)"
+  export TRIVY_JAVA_DB_REPOSITORY=ghcr.io/${owner}/trivy-java-db-act:latest
-  [ "$result" == '' ]
+  export TRIVY_CHECKS_BUNDLE_REPOSITORY=ghcr.io/${owner}/trivy-checks-act:latest
 }
 
-@test "trivy image sarif report" {
+setup() {
-  # trivy image --severity CRITICAL -f sarif --output image-sarif.test knqyf263/vuln-image:1.2.3
+  bats_load_library bats-support
-  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-b sarif' '-h image-sarif.test' '-g CRITICAL'
+  bats_load_library bats-assert
-  result="$(diff ./test/data/image-sarif.test image-sarif.test)"
+  bats_load_library bats-file
-  [ "$result" == '' ]
 }
 
-@test "trivy config" {
+function remove_json_fields() {
-  # trivy config --format json --output config.test .
+  local file="$1"
-  ./entrypoint.sh '-a config' '-j .' '-b json' '-h config.test'
+  if [[ "$file" == *.json ]]; then
-  result="$(diff ./test/data/config.test config.test)"
+      jq 'del(.CreatedAt)' "$file" > tmp && mv tmp "$file"
-  [ "$result" == '' ]
+  fi
 }
 
-@test "trivy rootfs" {
+function remove_sarif_fields() {
-  # trivy rootfs --format json --output rootfs.test .
+  local file="$1"
-  ./entrypoint.sh '-a rootfs' '-j .' '-b json' '-h rootfs.test'
+  if [[ "$file" == *.sarif ]]; then
-  result="$(diff ./test/data/rootfs.test rootfs.test)"
+      jq 'del(.runs[].tool.driver.version) | del(.runs[].originalUriBaseIds)' "$file" > tmp && mv tmp "$file"
-  [ "$result" == '' ]
+  fi
 }
 
-@test "trivy fs" {
+function remove_github_fields() {
-  # trivy fs --format json --output fs.test .
+  local file="$1"
-  ./entrypoint.sh '-a fs' '-j .' '-b json' '-h fs.test'
+  if [[ "$file" == *.gsbom  ]]; then
-  result="$(diff ./test/data/fs.test fs.test)"
+      jq 'del(.detector.version) | del(.scanned) | del(.job) | del(.ref) | del(.sha)' "$file" > tmp && mv tmp "$file"
-  [ "$result" == '' ]
+  fi
 }
 
-@test "trivy fs with securityChecks option" {
+function reset_envs() {
-  # trivy fs --format json --security-checks=vuln,config --output fs-scheck.test .
+  local var
-  ./entrypoint.sh '-a fs' '-j .' '-b json' '-s vuln,config,secret' '-h fs-scheck.test'
+  for var in $(env | grep '^TRIVY_\|^INPUT_' | cut -d= -f1); do
-  result="$(diff ./test/data/fs-scheck.test fs-scheck.test)"
+    unset "$var"
-  [ "$result" == '' ]
+  done
+}
+
+function compare_files() {
+  local file1="$1"
+  local file2="$2"
+
+  # Some fields should be removed as they are environment dependent 
+  # and may cause undesirable results when comparing files.
+  remove_json_fields "$file1"
+  remove_json_fields "$file2"
+
+  remove_sarif_fields "$file1"
+  remove_sarif_fields "$file2"
+
+  remove_github_fields "$file1"
+  remove_github_fields "$file2"
+  
+  run diff "$file1" "$file2"
+  echo "$output"
+  assert_files_equal "$file1" "$file2"
 }
 
 @test "trivy repo with securityCheck secret only" {
-  # trivy repo --format json --output repo.test --security-checks=secret https://github.com/krol3/demo-trivy/
+  # trivy repo -f json -o repo.test --scanners=secret https://github.com/krol3/demo-trivy/
-  ./entrypoint.sh '-b json' '-h repo.test' '-s secret' '-a repo' '-j https://github.com/krol3/demo-trivy/'
+  export TRIVY_FORMAT=json TRIVY_OUTPUT=repo.json TRIVY_SCANNERS=secret INPUT_SCAN_TYPE=repo INPUT_SCAN_REF="https://github.com/krol3/demo-trivy/"
-  result="$(diff ./test/data/repo.test repo.test)"
+  ./entrypoint.sh
-  [ "$result" == '' ]
+  compare_files repo.json ./test/data/secret-scan/report.json
+  reset_envs
+}
+
+@test "trivy image" {
+  # trivy image --severity CRITICAL -o image.test knqyf263/vuln-image:1.2.3
+  export TRIVY_OUTPUT=image.test TRIVY_SEVERITY=CRITICAL INPUT_SCAN_TYPE=image INPUT_SCAN_REF=knqyf263/vuln-image:1.2.3
+  ./entrypoint.sh
+  compare_files image.test ./test/data/image-scan/report
+  reset_envs
+}
+
+@test "trivy config sarif report" {
+  # trivy config -f sarif -o  config-sarif.test ./test/data/config-sarif-report
+  export TRIVY_FORMAT=sarif TRIVY_OUTPUT=config-sarif.sarif INPUT_SCAN_TYPE=config INPUT_SCAN_REF=./test/data/config-sarif-report
+  ./entrypoint.sh
+  compare_files config-sarif.sarif ./test/data/config-sarif-report/report.sarif
+  reset_envs
+}
+
+@test "trivy config" {
+  # trivy config -f json -o config.json ./test/data/config-scan
+  export TRIVY_FORMAT=json TRIVY_OUTPUT=config.json INPUT_SCAN_TYPE=config INPUT_SCAN_REF=./test/data/config-scan
+  ./entrypoint.sh
+  compare_files config.json ./test/data/config-scan/report.json
+  reset_envs
+}
+
+@test "trivy rootfs" {
+  # trivy rootfs --output rootfs.test ./test/data/rootfs-scan
+  # TODO: add data
+  export TRIVY_OUTPUT=rootfs.test INPUT_SCAN_TYPE=rootfs INPUT_SCAN_REF=./test/data/rootfs-scan
+  ./entrypoint.sh
+  compare_files rootfs.test ./test/data/rootfs-scan/report
+  reset_envs
+}
+
+@test "trivy fs" {
+  # trivy fs --output fs.test ./test/data/fs-scan
+  # TODO: add data
+  export TRIVY_OUTPUT=fs.test INPUT_SCAN_TYPE=fs INPUT_SCAN_REF=./test/data/fs-scan
+  ./entrypoint.sh
+  compare_files fs.test ./test/data/fs-scan/report
+  reset_envs
 }
 
 @test "trivy image with trivyIgnores option" {
-  # cat ./test/data/.trivyignore1 ./test/data/.trivyignore2 > ./trivyignores ; trivy image --severity CRITICAL --format json --output image-trivyignores.test --ignorefile ./trivyignores knqyf263/vuln-image:1.2.3
+  # cat ./test/data/with-ignore-files/.trivyignore1 ./test/data/with-ignore-files/.trivyignore2 > ./trivyignores ; trivy image --severity CRITICAL  --output image-trivyignores.test --ignorefile ./trivyignores knqyf263/vuln-image:1.2.3
-  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-b json' '-h image-trivyignores.test' '-g CRITICAL' '-t ./test/data/.trivyignore1,./test/data/.trivyignore2'
+  export TRIVY_OUTPUT=image-trivyignores.test TRIVY_SEVERITY=CRITICAL INPUT_SCAN_TYPE=image INPUT_IMAGE_REF=knqyf263/vuln-image:1.2.3 INPUT_TRIVYIGNORES="./test/data/with-ignore-files/.trivyignore1,./test/data/with-ignore-files/.trivyignore2"
-  result="$(diff ./test/data/image-trivyignores.test image-trivyignores.test)"
+  ./entrypoint.sh
-  [ "$result" == '' ]
+  compare_files image-trivyignores.test ./test/data/with-ignore-files/report
+  reset_envs
 }
 
 @test "trivy image with sbom output" {
-  # trivy image --format  github knqyf263/vuln-image:1.2.3
+  # trivy image --format github knqyf263/vuln-image:1.2.3
-  run ./entrypoint.sh  "-a image" "-b github" "-i knqyf263/vuln-image:1.2.3"
+  export TRIVY_FORMAT=github TRIVY_OUTPUT=github-dep-snapshot.gsbom INPUT_SCAN_TYPE=image INPUT_SCAN_REF=knqyf263/vuln-image:1.2.3
-  assert_output --partial '"package_url": "pkg:apk/ca-certificates@20171114-r0",' # TODO: Output contains time, need to mock
+  ./entrypoint.sh
+  compare_files github-dep-snapshot.gsbom ./test/data/github-dep-snapshot/report.gsbom
+  reset_envs
 }
+
+@test "trivy image with trivy.yaml config" {
+  # trivy --config=./test/data/with-trivy-yaml-cfg/trivy.yaml image alpine:3.10
+  export TRIVY_CONFIG=./test/data/with-trivy-yaml-cfg/trivy.yaml INPUT_SCAN_TYPE=image INPUT_SCAN_REF=alpine:3.10
+  ./entrypoint.sh
+  compare_files yamlconfig.json ./test/data/with-trivy-yaml-cfg/report.json
+  reset_envs
+}
+
+@test "trivy image with custom docker-host" {
+  # trivy image --docker-host unix:///var/run/docker.sock --severity CRITICAL --output image.test knqyf263/vuln-image:1.2.3
+  export TRIVY_OUTPUT=image.test TRIVY_SEVERITY=CRITICAL INPUT_SCAN_TYPE=image INPUT_SCAN_REF=knqyf263/vuln-image:1.2.3 TRIVY_DOCKER_HOST=unix:///var/run/docker.sock
+  ./entrypoint.sh
+  compare_files image.test ./test/data/image-scan/report
+  reset_envs
+}
+
+@test "trivy config with terraform variables" {
+  # trivy config -f json -o tfvars.json --severity  MEDIUM  --tf-vars  ./test/data/with-tf-vars/dev.tfvars ./test/data/with-tf-vars/main.tf
+  export TRIVY_FORMAT=json TRIVY_SEVERITY=MEDIUM TRIVY_OUTPUT=tfvars.json INPUT_SCAN_TYPE=config INPUT_SCAN_REF=./test/data/with-tf-vars/main.tf TRIVY_TF_VARS=./test/data/with-tf-vars/dev.tfvars
+  ./entrypoint.sh
+  compare_files tfvars.json ./test/data/with-tf-vars/report.json
+  reset_envs
+}

workflow.yml

@@ -7,10 +7,10 @@ on:
 jobs:
   build:
     name: Build
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Build an image from Dockerfile
         run: |
@@ -29,6 +29,6 @@ jobs:
           severity: 'CRITICAL,HIGH'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v2
+        uses: github/codeql-action/upload-sarif@v3
         with:
           sarif_file: 'trivy-results.sarif'