feat: add support for cache dire and timeout inputs (#35)

* Added input option support

* Fix position of input flag

* update readme

* Update README.md

Co-authored-by: Simarpreet Singh <simar@linux.com>

README.md

@@ -136,6 +136,7 @@ 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`, `template`)   |
@@ -145,7 +146,9 @@ Following inputs can be used as `step.with` keys:
 | `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 be displayed |
-
+| `skip-dirs`       | String  |                                   | Comma separated list of directories where traversal is skipped |
+| `cache-dir`      | String  |                                    | Cache directory                               |
+| `timeout`        | String  | `2m0s`                             | Scan timeout duration                         |
 [release]: https://github.com/aquasecurity/trivy-action/releases/latest
 [release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github
 [marketplace]: https://github.com/marketplace/actions/aqua-security-trivy

action.yaml

@@ -9,6 +9,10 @@ inputs:
   image-ref:
     description: 'image reference(for backward compatibility)'
     required: true
+  input:
+    description: 'reference of tar file to scan'
+    required: false
+    default: ''
   scan-ref:
     description: 'Scan reference'
     required: false
@@ -41,6 +45,18 @@ inputs:
     description: 'writes results to a file with the specified file name'
     required: false
     default: ''
+  skip-dirs:
+    description: 'comma separated list of directories where traversal is skipped'
+    required: false
+    default: ''
+  cache-dir:
+    description: 'specify where the cache is stored'
+    required: false
+    default: ''
+  timeout:
+    description: 'timeout (default 2m0s)'
+    required: false
+    default: ''
 runs:
   using: 'docker'
   image: "Dockerfile"
@@ -55,3 +71,7 @@ runs:
     - '-h ${{ inputs.output }}'
     - '-i ${{ inputs.image-ref }}'
     - '-j ${{ inputs.scan-ref }}'
+    - '-k ${{ inputs.skip-dirs }}'
+    - '-l ${{ inputs.input }}'
+    - '-m ${{ inputs.cache-dir }}'
+    - '-n ${{ inputs.timeout }}'

entrypoint.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e
-while getopts "a:b:c:d:e:f:g:h:i:j:" o; do
+while getopts "a:b:c:d:e:f:g:h:i:j:k:l:m:n:" o; do
    case "${o}" in
        a)
          export scanType=${OPTARG}
@@ -32,6 +32,18 @@ while getopts "a:b:c:d:e:f:g:h:i:j:" o; do
        j)
          export scanRef=${OPTARG}
        ;;
+       k)
+         export skipDirs=${OPTARG}
+       ;;
+       l)
+         export input=${OPTARG}
+       ;;
+       m)
+         export cacheDir=${OPTARG}
+       ;;
+       n)
+         export timeout=${OPTARG}
+       ;;
   esac
 done
 
@@ -40,6 +52,11 @@ export artifactRef="${imageRef}"
 if [ "${scanType}" = "fs" ];then
   artifactRef=$(echo $scanRef | tr -d '\r')
 fi
+input=$(echo $input | tr -d '\r')
+if [ $input ]; then
+  artifactRef="--input $input"
+fi
+ignoreUnfixed=$(echo $ignoreUnfixed | tr -d '\r')
 
 ARGS=""
 if [ $format ];then
@@ -63,6 +80,15 @@ fi
 if [ $output ];then
   ARGS="$ARGS --output $output"
 fi
+if [ $skipDirs ];then
+  ARGS="$ARGS --skip-dirs $skipDirs"
+fi
+if [ $cacheDir ];then
+  ARGS="$ARGS --cache-dir $cacheDir"
+fi
+if [ $timeout ];then
+  ARGS="$ARGS --timeout $timeout"
+fi
 
-echo "Runnin trivy with options" "${ARGS}" "${artifactRef}"
-trivy ${scanType} $ARGS ${artifactRef}
+echo "Running trivy with options: " --no-progress "${ARGS}" "${artifactRef}"
+trivy ${scanType} --no-progress $ARGS ${artifactRef}