Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8f4c7160b4 | ||
|
|
81cc8cd841 | ||
|
|
0769bbf0d2 | ||
|
|
9ec80b5796 | ||
|
|
a58433e1c9 | ||
|
|
7168e9ba5a | ||
|
|
2a2157eb22 | ||
|
|
1ccef265f5 | ||
|
|
d62898dfb3 | ||
|
|
6bce46377c | ||
|
|
101d9bacf6 | ||
|
|
8eccb55397 | ||
|
|
9438b49cc3 | ||
|
|
ac8de07fd1 | ||
|
|
09b815c470 | ||
|
|
0ce0e69d98 | ||
|
|
dba83feec8 | ||
|
|
c9017eb417 | ||
|
|
4ef054abe6 | ||
|
|
9789b6ae3b | ||
|
|
fd44a8c1a7 | ||
|
|
341f810bd6 | ||
|
|
731c4a9c64 | ||
|
|
9c91cd8af6 | ||
|
|
b38389f8ef | ||
|
|
e2054f8b6a | ||
|
|
6890ac5cba | ||
|
|
c6431cf821 | ||
|
|
f5e208a156 | ||
|
|
bceef37a45 | ||
|
|
7294c6a408 | ||
|
|
df28e4135d | ||
|
|
1d28acf359 | ||
|
|
7684771c94 | ||
|
|
8595c5d059 | ||
|
|
d8496b917f | ||
|
|
ddc1a12251 | ||
|
|
2e51a7d82c | ||
|
|
6087d9d64e | ||
|
|
888827683a | ||
|
|
7e2e12baea | ||
|
|
202e8283bd | ||
|
|
507a96efe4 | ||
|
|
6c3dd513ad | ||
|
|
28ef387ad0 |
@@ -0,0 +1,5 @@
|
|||||||
|
FROM aquasec/trivy:0.21.2
|
||||||
|
COPY entrypoint.sh /
|
||||||
|
RUN apk --no-cache add bash
|
||||||
|
RUN chmod +x /entrypoint.sh
|
||||||
|
ENTRYPOINT ["/entrypoint.sh"]
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
# Trivy Action
|
# Trivy Action
|
||||||
|
|
||||||
> [GitHub Action](https://github.com/features/actions) for Trivy
|
> [GitHub Action](https://github.com/features/actions) for [Trivy](https://github.com/aquasecurity/trivy)
|
||||||
|
|
||||||
[![GitHub Release][release-img]][release]
|
[![GitHub Release][release-img]][release]
|
||||||
[![GitHub Marketplace][marketplace-img]][marketplace]
|
[![GitHub Marketplace][marketplace-img]][marketplace]
|
||||||
@@ -12,6 +12,8 @@
|
|||||||
|
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Workflow](#workflow)
|
- [Workflow](#workflow)
|
||||||
|
- [Docker Image Scanning](#using-trivy-with-github-code-scanning)
|
||||||
|
- [Git Repository Scanning](#using-trivy-to-scan-your-git-repo)
|
||||||
- [Customizing](#customizing)
|
- [Customizing](#customizing)
|
||||||
- [Inputs](#inputs)
|
- [Inputs](#inputs)
|
||||||
|
|
||||||
@@ -31,22 +33,21 @@ jobs:
|
|||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-18.04
|
runs-on: ubuntu-18.04
|
||||||
steps:
|
steps:
|
||||||
- name: Setup Go
|
|
||||||
uses: actions/setup-go@v1
|
|
||||||
with:
|
|
||||||
go-version: 1.14
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Build an image from Dockerfile
|
- 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 vulnerability scanner
|
|
||||||
uses: aquasecurity/trivy-action@0.0.7
|
- name: Run Trivy vulnerability scanner
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
with:
|
with:
|
||||||
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
format: 'table'
|
format: 'table'
|
||||||
exit-code: '1'
|
exit-code: '1'
|
||||||
ignore-unfixed: true
|
ignore-unfixed: true
|
||||||
|
vuln-type: 'os,library'
|
||||||
severity: 'CRITICAL,HIGH'
|
severity: 'CRITICAL,HIGH'
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -64,31 +65,317 @@ jobs:
|
|||||||
name: Build
|
name: Build
|
||||||
runs-on: ubuntu-18.04
|
runs-on: ubuntu-18.04
|
||||||
steps:
|
steps:
|
||||||
- name: Setup Go
|
|
||||||
uses: actions/setup-go@v1
|
|
||||||
with:
|
|
||||||
go-version: 1.14
|
|
||||||
- name: Checkout code
|
- name: Checkout code
|
||||||
uses: actions/checkout@v2
|
uses: actions/checkout@v2
|
||||||
- name: Initialize CodeQL
|
|
||||||
uses: github/codeql-action/init@v1
|
|
||||||
- name: Build an image from Dockerfile
|
- 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 vulnerability scanner
|
|
||||||
|
- name: Run Trivy vulnerability scanner
|
||||||
uses: aquasecurity/trivy-action@master
|
uses: aquasecurity/trivy-action@master
|
||||||
with:
|
with:
|
||||||
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
format: 'template'
|
format: 'template'
|
||||||
template: '@/contrib/sarif.tpl'
|
template: '@/contrib/sarif.tpl'
|
||||||
output: 'trivy-results.sarif'
|
output: 'trivy-results.sarif'
|
||||||
- name: Upload Trivy scan results to Security tab
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
uses: github/codeql-action/upload-sarif@v1
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
with:
|
with:
|
||||||
sarif_file: 'trivy-results.sarif'
|
sarif_file: 'trivy-results.sarif'
|
||||||
```
|
```
|
||||||
|
|
||||||
You can find a more in-depth example here: https://github.com/aquasecurity/trivy-sarif-demo
|
You can find a more in-depth example here: https://github.com/aquasecurity/trivy-sarif-demo/blob/master/.github/workflows/scan.yml
|
||||||
|
|
||||||
|
If you would like to upload SARIF results to GitHub Code scanning even upon a non zero exit code from Trivy Scan, you can add the following to your upload step:
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- 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
|
||||||
|
with:
|
||||||
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
if: always()
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
See this for more details: https://docs.github.com/en/actions/learn-github-actions/expressions#always
|
||||||
|
|
||||||
|
### Using Trivy to scan your Git repo
|
||||||
|
It's also possible to scan your git 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:
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner in repo mode
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
scan-type: 'fs'
|
||||||
|
ignore-unfixed: true
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
severity: 'CRITICAL'
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using Trivy to scan your rootfs directories
|
||||||
|
It's also possible to scan your rootfs directories with Trivy's built-in rootfs 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:
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner with rootfs command
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
scan-type: 'rootfs'
|
||||||
|
scan-ref: 'rootfs-example-binary'
|
||||||
|
ignore-unfixed: true
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
severity: 'CRITICAL'
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Using Trivy to scan Infrastucture 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:
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner in IaC mode
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
scan-type: 'config'
|
||||||
|
hide-progress: false
|
||||||
|
format: 'table'
|
||||||
|
exit-code: '1'
|
||||||
|
ignore-unfixed: true
|
||||||
|
severity: 'CRITICAL,HIGH'
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|
#### Docker Hub registry
|
||||||
|
Docker Hub needs `TRIVY_USERNAME` and `TRIVY_PASSWORD`.
|
||||||
|
You don't need to set ENV vars when downloading from a public repository.
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
env:
|
||||||
|
TRIVY_USERNAME: Username
|
||||||
|
TRIVY_PASSWORD: Password
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### AWS ECR (Elastic Container Registry)
|
||||||
|
Trivy uses AWS SDK. You don't need to install `aws` CLI tool.
|
||||||
|
You can use [AWS CLI's ENV Vars][env-var].
|
||||||
|
|
||||||
|
[env-var]: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-envvars.html
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
image-ref: 'aws_account_id.dkr.ecr.region.amazonaws.com/imageName:${{ github.sha }}'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
env:
|
||||||
|
AWS_ACCESS_KEY_ID: key_id
|
||||||
|
AWS_SECRET_ACCESS_KEY: access_key
|
||||||
|
AWS_DEFAULT_REGION: us-west-2
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### GCR (Google Container Registry)
|
||||||
|
Trivy uses Google Cloud SDK. You don't need to install `gcloud` command.
|
||||||
|
|
||||||
|
If you want to use target project's repository, you can set it via `GOOGLE_APPLICATION_CREDENTIAL`.
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
env:
|
||||||
|
GOOGLE_APPLICATION_CREDENTIAL: /path/to/credential.json
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Self-Hosted
|
||||||
|
BasicAuth server needs `TRIVY_USERNAME` and `TRIVY_PASSWORD`.
|
||||||
|
if you want to use 80 port, use NonSSL `TRIVY_NON_SSL=true`
|
||||||
|
```yaml
|
||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Run Trivy vulnerability scanner
|
||||||
|
uses: aquasecurity/trivy-action@master
|
||||||
|
with:
|
||||||
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
env:
|
||||||
|
TRIVY_USERNAME: Username
|
||||||
|
TRIVY_PASSWORD: Password
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
|
```
|
||||||
|
|
||||||
## Customizing
|
## Customizing
|
||||||
|
|
||||||
@@ -98,17 +385,27 @@ 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`|
|
||||||
|
| `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 `.`|
|
||||||
| `format` | String | `table` | Output format (`table`, `json`, `template`) |
|
| `format` | String | `table` | Output format (`table`, `json`, `template`) |
|
||||||
| `template` | String | | Output template (`@/contrib/sarif.tpl`, `@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)|
|
| `template` | String | | Output template (`@/contrib/sarif.tpl`, `@/contrib/gitlab.tpl`, `@/contrib/junit.tpl`)|
|
||||||
| `output` | String | | Save results to a file |
|
| `output` | String | | Save results to a file |
|
||||||
| `exit-code` | String | `0` | Exit code when vulnerabilities were found |
|
| `exit-code` | String | `0` | Exit code when specified vulnerabilities are found |
|
||||||
| `ignore-unfixed` | Boolean | false | Ignore unpatched/unfixed vulnerabilities |
|
| `ignore-unfixed` | Boolean | false | Ignore unpatched/unfixed vulnerabilities |
|
||||||
| `severity` | String | `UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL` | Severities of vulnerabilities to be displayed |
|
| `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 | `2m0s` | Scan timeout duration |
|
||||||
|
| `ignore-policy` | String | | Filter vulnerabilities with OPA rego language |
|
||||||
|
| `list-all-pkgs` | String | | Output all packages regardless of vulnerability |
|
||||||
|
|
||||||
[release]: https://github.com/aquasecurity/trivy-action/releases/latest
|
[release]: https://github.com/aquasecurity/trivy-action/releases/latest
|
||||||
[release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github
|
[release-img]: https://img.shields.io/github/release/aquasecurity/trivy-action.svg?logo=github
|
||||||
[marketplace]: https://github.com/marketplace/actions/trivy-vulnerability-scanner
|
[marketplace]: https://github.com/marketplace/actions/aqua-security-trivy
|
||||||
[marketplace-img]: https://img.shields.io/badge/marketplace-trivy--action-blue?logo=github
|
[marketplace-img]: https://img.shields.io/badge/marketplace-trivy--action-blue?logo=github
|
||||||
[license]: https://github.com/aquasecurity/trivy-action/blob/master/LICENSE
|
[license]: https://github.com/aquasecurity/trivy-action/blob/master/LICENSE
|
||||||
[license-img]: https://img.shields.io/github/license/aquasecurity/trivy-action
|
[license-img]: https://img.shields.io/github/license/aquasecurity/trivy-action
|
||||||
|
|||||||
+65
-11
@@ -2,9 +2,21 @@ name: 'Aqua Security Trivy'
|
|||||||
description: 'Scans container images for vulnerabilities with Trivy'
|
description: 'Scans container images for vulnerabilities with Trivy'
|
||||||
author: 'Aqua Security'
|
author: 'Aqua Security'
|
||||||
inputs:
|
inputs:
|
||||||
|
scan-type:
|
||||||
|
description: 'Scan type to use for scanning vulnerability'
|
||||||
|
required: false
|
||||||
|
default: 'image'
|
||||||
image-ref:
|
image-ref:
|
||||||
description: 'image reference'
|
description: 'image reference(for backward compatibility)'
|
||||||
required: true
|
required: true
|
||||||
|
input:
|
||||||
|
description: 'reference of tar file to scan'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
scan-ref:
|
||||||
|
description: 'Scan reference'
|
||||||
|
required: false
|
||||||
|
default: '.'
|
||||||
exit-code:
|
exit-code:
|
||||||
description: 'exit code when vulnerabilities were found'
|
description: 'exit code when vulnerabilities were found'
|
||||||
required: false
|
required: false
|
||||||
@@ -12,7 +24,11 @@ inputs:
|
|||||||
ignore-unfixed:
|
ignore-unfixed:
|
||||||
description: 'ignore unfixed vulnerabilities'
|
description: 'ignore unfixed vulnerabilities'
|
||||||
required: false
|
required: false
|
||||||
default: false
|
default: 'false'
|
||||||
|
vuln-type:
|
||||||
|
description: 'comma-separated list of vulnerability types (os,library)'
|
||||||
|
required: false
|
||||||
|
default: 'os,library'
|
||||||
severity:
|
severity:
|
||||||
description: 'severities of vulnerabilities to be displayed'
|
description: 'severities of vulnerabilities to be displayed'
|
||||||
required: false
|
required: false
|
||||||
@@ -29,15 +45,53 @@ inputs:
|
|||||||
description: 'writes results to a file with the specified file name'
|
description: 'writes results to a file with the specified file name'
|
||||||
required: false
|
required: false
|
||||||
default: ''
|
default: ''
|
||||||
|
skip-dirs:
|
||||||
|
description: 'comma separated list of directories where traversal is skipped'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
skip-files:
|
||||||
|
description: 'comma separated list of files to be skipped'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
cache-dir:
|
||||||
|
description: 'specify where the cache is stored'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
timeout:
|
||||||
|
description: 'timeout (default 5m0s)'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
ignore-policy:
|
||||||
|
description: 'filter vulnerabilities with OPA rego language'
|
||||||
|
required: false
|
||||||
|
default: ''
|
||||||
|
hide-progress:
|
||||||
|
description: 'hide progress output'
|
||||||
|
required: false
|
||||||
|
default: 'true'
|
||||||
|
list-all-pkgs:
|
||||||
|
description: 'output all packages regardless of vulnerability'
|
||||||
|
required: false
|
||||||
|
default: 'false'
|
||||||
runs:
|
runs:
|
||||||
using: 'docker'
|
using: 'docker'
|
||||||
image: 'docker://docker.io/aquasec/trivy:latest'
|
image: "Dockerfile"
|
||||||
args:
|
args:
|
||||||
- 'image'
|
- '-a ${{ inputs.scan-type }}'
|
||||||
- '--format=${{ inputs.format }}'
|
- '-b ${{ inputs.format }}'
|
||||||
- '--template=${{ inputs.template }}'
|
- '-c ${{ inputs.template }}'
|
||||||
- '--exit-code=${{ inputs.exit-code }}'
|
- '-d ${{ inputs.exit-code }}'
|
||||||
- '--ignore-unfixed=${{ inputs.ignore-unfixed }}'
|
- '-e ${{ inputs.ignore-unfixed }}'
|
||||||
- '--severity=${{ inputs.severity }}'
|
- '-f ${{ inputs.vuln-type }}'
|
||||||
- '--output=${{ inputs.output }}'
|
- '-g ${{ inputs.severity }}'
|
||||||
- '${{ inputs.image-ref }}'
|
- '-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 }}'
|
||||||
|
- '-o ${{ inputs.ignore-policy }}'
|
||||||
|
- '-p ${{ inputs.hide-progress }}'
|
||||||
|
- '-q ${{ inputs.skip-files }}'
|
||||||
|
- '-r ${{ inputs.list-all-pkgs }}'
|
||||||
|
|||||||
Executable
+146
@@ -0,0 +1,146 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
while getopts "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:" 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}
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
scanType=$(echo $scanType | tr -d '\r')
|
||||||
|
export artifactRef="${imageRef}"
|
||||||
|
if [ "${scanType}" = "fs" ] || [ "${scanType}" = "config" ] || [ "${scanType}" = "rootfs" ];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')
|
||||||
|
hideProgress=$(echo $hideProgress | tr -d '\r')
|
||||||
|
|
||||||
|
GLOBAL_ARGS=""
|
||||||
|
if [ $cacheDir ];then
|
||||||
|
GLOBAL_ARGS="$GLOBAL_ARGS --cache-dir $cacheDir"
|
||||||
|
fi
|
||||||
|
|
||||||
|
SARIF_ARGS=""
|
||||||
|
ARGS=""
|
||||||
|
if [ $format ];then
|
||||||
|
ARGS="$ARGS --format $format"
|
||||||
|
fi
|
||||||
|
if [ $template ] ;then
|
||||||
|
ARGS="$ARGS --template $template"
|
||||||
|
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" ];then
|
||||||
|
ARGS="$ARGS --vuln-type $vulnType"
|
||||||
|
SARIF_ARGS="$SARIF_ARGS --vuln-type $vulnType"
|
||||||
|
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 [ $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')
|
||||||
|
if [ "$listAllPkgs" == "true" ];then
|
||||||
|
ARGS="$ARGS --list-all-pkgs"
|
||||||
|
fi
|
||||||
|
if [ "$skipFiles" ];then
|
||||||
|
for i in $(echo $skipFiles | tr "," "\n")
|
||||||
|
do
|
||||||
|
ARGS="$ARGS --skip-files $i"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "Running trivy with options: ${ARGS}" "${artifactRef}"
|
||||||
|
echo "Global options: " "${GLOBAL_ARGS}"
|
||||||
|
trivy $GLOBAL_ARGS ${scanType} $ARGS ${artifactRef}
|
||||||
|
returnCode=$?
|
||||||
|
|
||||||
|
# SARIF is special. We output all vulnerabilities,
|
||||||
|
# regardless of severity level specified in this report.
|
||||||
|
# This is a feature, not a bug :)
|
||||||
|
if [[ ${template} == *"sarif"* ]]; then
|
||||||
|
echo "Building SARIF report with options: ${SARIF_ARGS}" "${artifactRef}"
|
||||||
|
trivy --quiet ${scanType} --format template --template ${template} --output ${output} $SARIF_ARGS ${artifactRef}
|
||||||
|
fi
|
||||||
|
|
||||||
|
exit $returnCode
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
name: build
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build
|
||||||
|
runs-on: ubuntu-18.04
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- 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
|
||||||
|
with:
|
||||||
|
image-ref: 'docker.io/my-organization/my-app:${{ github.sha }}'
|
||||||
|
exit-code: '1'
|
||||||
|
ignore-unfixed: true
|
||||||
|
vuln-type: 'os,library'
|
||||||
|
format: 'template'
|
||||||
|
template: '@/contrib/sarif.tpl'
|
||||||
|
output: 'trivy-results.sarif'
|
||||||
|
severity: 'CRITICAL,HIGH'
|
||||||
|
|
||||||
|
- name: Upload Trivy scan results to GitHub Security tab
|
||||||
|
uses: github/codeql-action/upload-sarif@v1
|
||||||
|
with:
|
||||||
|
sarif_file: 'trivy-results.sarif'
|
||||||
Reference in New Issue
Block a user