docs(trivy): Add instructions to scan tarballs. (#134)

Signed-off-by: Simar <simar@linux.com>

.github/workflows/build.yaml

@@ -1,7 +1,7 @@
 name: "build"
 on: [push, pull_request]
 env:
-  TRIVY_VERSION: 0.28.1
+  TRIVY_VERSION: 0.29.2
 jobs:
   build:
     name: build
@@ -13,6 +13,9 @@ jobs:
         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
 
@@ -21,4 +24,10 @@ jobs:
           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 .
+        run: bats --recursive --timing .
+
+      - name: Debug show artifacts
+        if: always()
+        run: |
+          cat ./config.test
+          cat ./fs-scheck.test

Dockerfile

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

README.md

@@ -51,6 +51,35 @@ jobs:
           severity: 'CRITICAL,HIGH'
 ```
 
+
+### Scanning a Tarball
+```yaml
+name: build
+on:
+  push:
+    branches:
+    - master
+  pull_request:
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-20.04
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - 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@master
+      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
@@ -80,7 +109,7 @@ jobs:
           output: 'trivy-results.sarif'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -115,7 +144,7 @@ jobs:
           output: 'trivy-results.sarif'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         if: always()
         with:
           sarif_file: 'trivy-results.sarif'
@@ -152,7 +181,7 @@ jobs:
           severity: 'CRITICAL'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -187,7 +216,7 @@ jobs:
           severity: 'CRITICAL'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -222,11 +251,43 @@ jobs:
           severity: 'CRITICAL,HIGH'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         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.
+
+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. 
+
+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
+  pull_request:
+jobs:
+  build:
+    name: Checks
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run Trivy in GitHub SBOM mode and submit results to Dependency Snapshots
+        uses: aquasecurity/trivy-action@master
+        with:
+          scan-type: 'fs'
+          format: 'github'
+          output: 'dependency-results.sbom.json'
+          image-ref: '.'
+          github-pat: '<github_pat_token>'
+```
+
 ### Using Trivy to scan your private registry
 It's also possible to scan your private registry with Trivy's built-in image scan. All you have to do is set ENV vars.
 
@@ -259,7 +320,7 @@ jobs:
           TRIVY_PASSWORD: Password
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -296,7 +357,7 @@ jobs:
           AWS_DEFAULT_REGION: us-west-2
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -330,7 +391,7 @@ jobs:
           GOOGLE_APPLICATION_CREDENTIAL: /path/to/credential.json
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -364,7 +425,7 @@ jobs:
           TRIVY_PASSWORD: Password
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'
 ```
@@ -375,27 +436,29 @@ jobs:
 
 Following inputs can be used as `step.with` keys:
 
-| Name             | Type    | Default                            | Description                                   |
-|------------------|---------|------------------------------------|-----------------------------------------------|
-| `scan-type`      | String  | `image`                            | Scan type, e.g. `image` or `fs`|
-| `input`          | String  |                                    | Tar reference, e.g. `alpine-latest.tar` |
-| `image-ref`      | String  |                                    | Image reference, e.g. `alpine:3.10.2`         |
-| `scan-ref`       | String  | `/github/workspace/`               | Scan reference, e.g. `/github/workspace/` or `.`|
-| `format`         | String  | `table`                            | Output format (`table`, `json`, `sarif`)   |
-| `template`       | String  |                                    | Output template (`@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)|
-| `output`         | String  |                                    | Save results to a file                        |
-| `exit-code`      | String  | `0`                                | Exit code when specified vulnerabilities are found     |
-| `ignore-unfixed` | Boolean | false                              | Ignore unpatched/unfixed vulnerabilities      |
-| `vuln-type`      | String  | `os,library`                       | Vulnerability types (os,library)              |
-| `severity`       | String  | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to scanned for and displayed |
-| `skip-dirs`      | String  |                                    | Comma separated list of directories where traversal is skipped |
-| `skip-files`     | String  |                                    | Comma separated list of files where traversal is skipped |
-| `cache-dir`      | String  |                                    | Cache directory                               |
-| `timeout`        | String  | `5m0s`                             | Scan timeout duration                         |
-| `ignore-policy`  | String  |                                    | Filter vulnerabilities with OPA rego language |
-| `list-all-pkgs`  | String  |                                    | Output all packages regardless of vulnerability |
-| `security-checks`| String  | `vuln,secret`                      | comma-separated list of what security issues to detect (`vuln`,`secret`,`config`)|
-| `trivyignores`   | String  |                                    | comma-separated list of relative paths in repository to one or more `.trivyignore` files |
+| Name              | Type    | Default                            | Description                                                                                     |
+|-------------------|---------|------------------------------------|-------------------------------------------------------------------------------------------------|
+| `scan-type`       | String  | `image`                            | Scan type, e.g. `image` or `fs`                                                                 |
+| `input`           | String  |                                    | Tar reference, e.g. `alpine-latest.tar`                                                         |
+| `image-ref`       | String  |                                    | Image reference, e.g. `alpine:3.10.2`                                                           |
+| `scan-ref`        | String  | `/github/workspace/`               | Scan reference, e.g. `/github/workspace/` or `.`                                                |
+| `format`          | String  | `table`                            | Output format (`table`, `json`, `sarif`, `github`)                                              |
+| `template`        | String  |                                    | Output template (`@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)                                 |
+| `output`          | String  |                                    | Save results to a file                                                                          |
+| `exit-code`       | String  | `0`                                | Exit code when specified vulnerabilities are found                                              |
+| `ignore-unfixed`  | Boolean | false                              | Ignore unpatched/unfixed vulnerabilities                                                        |
+| `vuln-type`       | String  | `os,library`                       | Vulnerability types (os,library)                                                                |
+| `severity`        | String  | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to scanned for and displayed                                      |
+| `skip-dirs`       | String  |                                    | Comma separated list of directories where traversal is skipped                                  |
+| `skip-files`      | String  |                                    | Comma separated list of files where traversal is skipped                                        |
+| `cache-dir`       | String  |                                    | Cache directory                                                                                 |
+| `timeout`         | String  | `5m0s`                             | Scan timeout duration                                                                           |
+| `ignore-policy`   | String  |                                    | Filter vulnerabilities with OPA rego language                                                   |
+| `hide-progress`   | String  | `true`                             | Suppress progress bar                                                                           |
+| `list-all-pkgs`   | String  |                                    | Output all packages regardless of vulnerability                                                 |
+| `security-checks` | String  | `vuln,secret`                      | comma-separated list of what security issues to detect (`vuln`,`secret`,`config`)               |
+| `trivyignores`    | String  |                                    | comma-separated list of relative paths in repository to one or more `.trivyignore` files        |
+| `github-pat`      | String  |                                    | GitHub Personal Access Token (PAT) for sending SBOM scan results to GitHub Dependency Snapshots |
 
 [release]: https://github.com/aquasecurity/trivy-action/releases/latest
 [release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github

action.yaml

@@ -20,7 +20,6 @@ inputs:
   exit-code:
     description: 'exit code when vulnerabilities were found'
     required: false
-    default: '0'
   ignore-unfixed:
     description: 'ignore unfixed vulnerabilities'
     required: false
@@ -38,7 +37,7 @@ inputs:
     required: false
     default: 'table'
   template:
-    description: 'use an existing template for rendering output (@/contrib/sarif.tpl, @/contrib/gitlab.tpl, @/contrib/junit.tpl'
+    description: 'use an existing template for rendering output (@/contrib/gitlab.tpl, @/contrib/junit.tpl, @/contrib/html.tpl)'
     required: false
     default: ''
   output:
@@ -68,7 +67,6 @@ inputs:
   hide-progress:
     description: 'hide progress output'
     required: false
-    default: 'true'
   list-all-pkgs:
     description: 'output all packages regardless of vulnerability'
     required: false
@@ -81,6 +79,13 @@ 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
+
 runs:
   using: 'docker'
   image: "Dockerfile"
@@ -105,3 +110,4 @@ runs:
     - '-r ${{ inputs.list-all-pkgs }}'
     - '-s ${{ inputs.security-checks }}'
     - '-t ${{ inputs.trivyignores }}'
+    - '-u ${{ inputs.github-pat }}'

entrypoint.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e
-while getopts "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:" o; do
+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}
@@ -62,6 +62,9 @@ while getopts "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:" o; do
        t)
          export trivyIgnores=${OPTARG}
        ;;
+       u)
+         export githubPAT=${OPTARG}
+       ;;
   esac
 done
 
@@ -84,6 +87,7 @@ fi
 
 SARIF_ARGS=""
 ARGS=""
+format=$(echo $format | xargs)
 if [ $format ];then
  ARGS="$ARGS --format $format"
 fi
@@ -97,7 +101,7 @@ if [ "$ignoreUnfixed" == "true" ] && [ "$scanType" != "config" ];then
   ARGS="$ARGS --ignore-unfixed"
   SARIF_ARGS="$SARIF_ARGS --ignore-unfixed"
 fi
-if [ $vulnType ] && [ "$scanType" != "config" ];then
+if [ $vulnType ] && [ "$scanType" != "config" ] && [ "$scanType" != "sbom" ];then
   ARGS="$ARGS --vuln-type $vulnType"
   SARIF_ARGS="$SARIF_ARGS --vuln-type $vulnType"
 fi
@@ -166,4 +170,9 @@ if [[ "${format}" == "sarif" ]]; then
   trivy --quiet ${scanType} --format sarif --output ${output} $SARIF_ARGS ${artifactRef}
 fi
 
+if [[ "${format}" == "github" ]] && [[ "$(echo $githubPAT | xargs)" != "" ]]; then
+  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.test

@@ -20,7 +20,7 @@
       "Class": "config",
       "Type": "dockerfile",
       "MisconfSummary": {
-        "Successes": 22,
+        "Successes": 21,
         "Failures": 1,
         "Exceptions": 0
       },

test/data/fs-scheck.test

@@ -20,7 +20,7 @@
       "Class": "config",
       "Type": "dockerfile",
       "MisconfSummary": {
-        "Successes": 22,
+        "Successes": 21,
         "Failures": 1,
         "Exceptions": 0
       },

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/repo.test

@@ -1,34 +1,5 @@
-{
-  "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=*****"
-        }
-      ]
-    }
-  ]
-}
+┌──────────┬──────────────────────────────┬──────────┬─────────┬─────────────────────────┐
+│ Category │         Description          │ Severity │ Line No │          Match          │
+├──────────┼──────────────────────────────┼──────────┼─────────┼─────────────────────────┤
+│  GitHub  │ GitHub Personal Access Token │ CRITICAL │    5    │ 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/test.bats

@@ -1,57 +1,65 @@
 #!/usr/bin/env bats
+load '/usr/lib/bats-support/load.bash'
+load '/usr/lib/bats-assert/load.bash'
 
 @test "trivy image" {
-  # trivy image --severity CRITICAL --format json --output image.test knqyf263/vuln-image:1.2.3
-  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-b json' '-h image.test' '-g CRITICAL'
+  # trivy image --severity CRITICAL --output image.test knqyf263/vuln-image:1.2.3
+  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-h image.test' '-g CRITICAL'
   result="$(diff ./test/data/image.test image.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy image sarif report" {
   # trivy image --severity CRITICAL -f sarif --output image-sarif.test knqyf263/vuln-image:1.2.3
-  ./entrypoint.sh '-a image' '-i knqyf263/vuln-image:1.2.3' '-b sarif' '-h image-sarif.test' '-g CRITICAL'
+  ./entrypoint.sh '-a image' '-b sarif' '-i knqyf263/vuln-image:1.2.3' '-h image-sarif.test' '-g CRITICAL'
   result="$(diff ./test/data/image-sarif.test image-sarif.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy config" {
   # trivy config --format json --output config.test .
-  ./entrypoint.sh '-a config' '-j .' '-b json' '-h config.test'
+  ./entrypoint.sh '-a config' '-b json' '-j .' '-h config.test'
   result="$(diff ./test/data/config.test config.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy rootfs" {
-  # trivy rootfs --format json --output rootfs.test .
-  ./entrypoint.sh '-a rootfs' '-j .' '-b json' '-h rootfs.test'
+  # trivy rootfs --output rootfs.test .
+  ./entrypoint.sh '-a rootfs' '-j .' '-h rootfs.test'
   result="$(diff ./test/data/rootfs.test rootfs.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy fs" {
-  # trivy fs --format json --output fs.test .
-  ./entrypoint.sh '-a fs' '-j .' '-b json' '-h fs.test'
+  # trivy fs --output fs.test .
+  ./entrypoint.sh '-a fs' '-j .' '-h fs.test'
   result="$(diff ./test/data/fs.test fs.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy fs with securityChecks option" {
   # trivy fs --format json --security-checks=vuln,config --output fs-scheck.test .
-  ./entrypoint.sh '-a fs' '-j .' '-b json' '-s vuln,config,secret' '-h fs-scheck.test'
+  ./entrypoint.sh '-a fs' '-b json' '-j .' '-s vuln,config,secret' '-h fs-scheck.test'
   result="$(diff ./test/data/fs-scheck.test fs-scheck.test)"
   [ "$result" == '' ]
 }
 
 @test "trivy repo with securityCheck secret only" {
-  # trivy repo --format json --output repo.test --security-checks=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/'
+  # trivy repo --output repo.test --security-checks=secret https://github.com/krol3/demo-trivy/
+  ./entrypoint.sh '-h repo.test' '-s secret' '-a repo' '-j https://github.com/krol3/demo-trivy/'
   result="$(diff ./test/data/repo.test repo.test)"
   [ "$result" == '' ]
 }
 
 @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
-  ./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'
+  # cat ./test/data/.trivyignore1 ./test/data/.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' '-h image-trivyignores.test' '-g CRITICAL' '-t ./test/data/.trivyignore1,./test/data/.trivyignore2'
   result="$(diff ./test/data/image-trivyignores.test image-trivyignores.test)"
   [ "$result" == '' ]
 }
+
+@test "trivy image with sbom output" {
+  # trivy image --format  github knqyf263/vuln-image:1.2.3
+  run ./entrypoint.sh  "-a image" "-b github" "-i knqyf263/vuln-image:1.2.3"
+  assert_output --partial '"package_url": "pkg:apk/ca-certificates@20171114-r0",' # TODO: Output contains time, need to mock
+}

workflow.yml

@@ -29,6 +29,6 @@ jobs:
           severity: 'CRITICAL,HIGH'
 
       - name: Upload Trivy scan results to GitHub Security tab
-        uses: github/codeql-action/upload-sarif@v1
+        uses: github/codeql-action/upload-sarif@v2
         with:
           sarif_file: 'trivy-results.sarif'